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 *, bool );
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 assert (i_size >= sizeof (vlc_object_t));
119 p_new = (vlc_object_t *)(p_priv + 1);
121 p_new->i_object_type = i_type;
122 p_new->psz_object_type = psz_type;
123 p_new->psz_object_name = NULL;
125 p_new->b_die = false;
126 p_new->b_error = false;
127 p_new->b_dead = false;
128 p_priv->b_attached = false;
129 p_new->b_force = false;
131 p_new->psz_header = NULL;
134 p_new->i_flags = p_this->i_flags
135 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
137 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
139 if( !p_priv->p_vars )
145 libvlc_global_data_t *p_libvlc_global;
148 /* Only the global root object is created out of the blue */
149 p_libvlc_global = (libvlc_global_data_t *)p_new;
150 p_new->p_libvlc = NULL;
152 p_libvlc_global->i_counter = 0;
153 p_libvlc_global->i_objects = 0;
154 p_libvlc_global->pp_objects = NULL;
155 p_priv->b_attached = true;
156 vlc_mutex_init( &structure_lock );
160 p_libvlc_global = vlc_global();
161 if( i_type == VLC_OBJECT_LIBVLC )
163 p_new->p_libvlc = (libvlc_int_t*)p_new;
164 p_priv->b_attached = true;
168 p_new->p_libvlc = p_this->p_libvlc;
172 p_priv->i_refcount = 1;
173 p_priv->pf_destructor = kVLCDestructor;
174 p_priv->b_thread = false;
175 p_new->p_parent = NULL;
176 p_new->pp_children = NULL;
177 p_new->i_children = 0;
179 p_new->p_private = NULL;
181 /* Initialize mutexes and condvars */
182 vlc_mutex_init( &p_new->object_lock );
183 vlc_cond_init( p_new, &p_new->object_wait );
184 vlc_mutex_init( &p_priv->var_lock );
185 vlc_spin_init( &p_priv->spin );
186 p_priv->pipes[0] = p_priv->pipes[1] = -1;
188 vlc_mutex_lock( &structure_lock );
189 p_new->i_object_id = p_libvlc_global->i_counter++;
191 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
192 * useless to try and recover anything if pp_objects gets smashed. */
193 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
195 vlc_mutex_unlock( &structure_lock );
197 if( i_type == VLC_OBJECT_LIBVLC )
199 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
200 var_AddCallback( p_new, "list", DumpCommand, NULL );
201 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
202 var_AddCallback( p_new, "tree", DumpCommand, NULL );
203 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
204 var_AddCallback( p_new, "vars", DumpCommand, NULL );
212 * Allocates and initializes a vlc object.
214 * @param i_type known object type (all of them are negative integer values),
215 * or object byte size (always positive).
217 * @return the new object, or NULL on error.
219 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
221 const char * psz_type;
226 case VLC_OBJECT_LIBVLC:
227 i_size = sizeof(libvlc_int_t);
230 case VLC_OBJECT_INTF:
231 i_size = sizeof(intf_thread_t);
232 psz_type = "interface";
234 case VLC_OBJECT_DIALOGS:
235 i_size = sizeof(intf_thread_t);
236 psz_type = "dialogs";
238 case VLC_OBJECT_DEMUX:
239 i_size = sizeof(demux_t);
242 case VLC_OBJECT_ACCESS:
243 i_size = sizeof(access_t);
246 case VLC_OBJECT_DECODER:
247 i_size = sizeof(decoder_t);
248 psz_type = "decoder";
250 case VLC_OBJECT_PACKETIZER:
251 i_size = sizeof(decoder_t);
252 psz_type = "packetizer";
254 case VLC_OBJECT_ENCODER:
255 i_size = sizeof(encoder_t);
256 psz_type = "encoder";
258 case VLC_OBJECT_FILTER:
259 i_size = sizeof(filter_t);
262 case VLC_OBJECT_VOUT:
263 i_size = sizeof(vout_thread_t);
264 psz_type = "video output";
266 case VLC_OBJECT_AOUT:
267 i_size = sizeof(aout_instance_t);
268 psz_type = "audio output";
270 case VLC_OBJECT_SOUT:
271 i_size = sizeof(sout_instance_t);
272 psz_type = "stream output";
274 case VLC_OBJECT_OPENGL:
275 i_size = sizeof( vout_thread_t );
278 case VLC_OBJECT_ANNOUNCE:
279 i_size = sizeof( announce_handler_t );
280 psz_type = "announce";
282 case VLC_OBJECT_INTERACTION:
283 i_size = sizeof( interaction_t );
284 psz_type = "interaction";
287 i_size = i_type > (int)sizeof(vlc_object_t)
288 ? i_type : (int)sizeof(vlc_object_t);
289 i_type = VLC_OBJECT_GENERIC;
290 psz_type = "generic";
294 return vlc_custom_create( p_this, i_size, i_type, psz_type );
299 ****************************************************************************
300 * Set the destructor of a vlc object
302 * This function sets the destructor of the vlc object. It will be called
303 * when the object is destroyed when the its refcount reaches 0.
304 * (It is called by the internal function vlc_object_destroy())
305 *****************************************************************************/
306 void __vlc_object_set_destructor( vlc_object_t *p_this,
307 vlc_destructor_t pf_destructor )
309 vlc_object_internals_t *p_priv = vlc_internals(p_this );
310 p_priv->pf_destructor = pf_destructor;
314 ****************************************************************************
315 * Destroy a vlc object (Internal)
317 * This function destroys an object that has been previously allocated with
318 * vlc_object_create. The object's refcount must be zero and it must not be
319 * attached to other objects in any way.
320 *****************************************************************************/
321 static void vlc_object_destroy( vlc_object_t *p_this )
323 vlc_object_internals_t *p_priv = vlc_internals( p_this );
325 /* Automatically detach the object from its parents */
326 if( p_this->p_parent ) vlc_object_detach( p_this );
329 /* Send a kill to the object's thread if applicable */
330 vlc_object_kill( p_this );
332 /* If we are running on a thread, wait until it ends */
333 if( p_priv->b_thread )
334 vlc_thread_join( p_this );
336 /* Call the custom "subclass" destructor */
337 if( p_priv->pf_destructor )
338 p_priv->pf_destructor( p_this );
341 if( p_this->i_children )
346 "ERROR: cannot delete object (%i, %s) with %d children\n",
347 p_this->i_object_id, p_this->psz_object_name,
348 p_this->i_children );
350 for( i = 0; i < p_this->i_children; i++ )
353 "ERROR: Remaining children object "
354 "(id:%i, type:%s, name:%s)\n",
355 p_this->pp_children[i]->i_object_id,
356 p_this->pp_children[i]->psz_object_type,
357 p_this->pp_children[i]->psz_object_name );
361 /* Dump libvlc object to ease debugging */
362 vlc_object_dump( p_this->p_libvlc );
367 /* Destroy the associated variables, starting from the end so that
368 * no memmove calls have to be done. */
369 while( p_priv->i_vars )
371 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
374 free( p_priv->p_vars );
375 vlc_mutex_destroy( &p_priv->var_lock );
377 free( p_this->psz_header );
379 if( p_this->p_libvlc == NULL )
381 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
384 assert( p_global == vlc_global() );
386 if( p_global->i_objects > 0 )
389 for( i = 0; i < p_global->i_objects; i++ )
391 /* We are leaking this object */
393 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
394 p_global->pp_objects[i]->i_object_id,
395 p_global->pp_objects[i]->psz_object_type,
396 p_global->pp_objects[i]->psz_object_name );
398 /* Dump libvlc object to ease debugging */
399 vlc_object_dump( p_global->pp_objects[i] );
404 /* Dump libvlc object to ease debugging */
405 vlc_object_dump( p_this );
407 /* Strongly abort, cause we want these to be fixed */
412 /* We are the global object ... no need to lock. */
413 free( p_global->pp_objects );
414 p_global->pp_objects = NULL;
416 vlc_mutex_destroy( &structure_lock );
419 FREENULL( p_this->psz_object_name );
421 #if defined(WIN32) || defined(UNDER_CE)
422 /* if object has an associated thread, close it now */
423 if( p_priv->thread_id.hThread )
424 CloseHandle(p_priv->thread_id.hThread);
427 vlc_mutex_destroy( &p_this->object_lock );
428 vlc_cond_destroy( &p_this->object_wait );
429 vlc_spin_destroy( &p_priv->spin );
430 if( p_priv->pipes[1] != -1 )
431 close( p_priv->pipes[1] );
432 if( p_priv->pipes[0] != -1 )
433 close( p_priv->pipes[0] );
439 /** Inter-object signaling */
441 void __vlc_object_lock( vlc_object_t *obj )
443 vlc_mutex_lock( &obj->object_lock );
446 void __vlc_object_unlock( vlc_object_t *obj )
448 vlc_assert_locked( &obj->object_lock );
449 vlc_mutex_unlock( &obj->object_lock );
453 # include <winsock2.h>
454 # include <ws2tcpip.h>
457 * select()-able pipes emulated using Winsock
459 static int pipe (int fd[2])
462 int addrlen = sizeof (addr);
464 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
465 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
466 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
469 memset (&addr, 0, sizeof (addr));
470 addr.sin_family = AF_INET;
471 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
472 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
473 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
475 || connect (c, (PSOCKADDR)&addr, addrlen))
478 a = accept (l, NULL, NULL);
479 if (a == INVALID_SOCKET)
490 if (l != INVALID_SOCKET)
492 if (c != INVALID_SOCKET)
498 #define read( a, b, c ) recv (a, b, c, 0)
500 #define write( a, b, c ) send (a, b, c, 0)
502 #define close( a ) closesocket (a)
506 * Returns the readable end of a pipe that becomes readable once termination
507 * of the object is requested (vlc_object_kill()).
508 * This can be used to wake-up out of a select() or poll() event loop, such
509 * typically when doing network I/O.
511 * Note that the pipe will remain the same for the lifetime of the object.
512 * DO NOT read the pipe nor close it yourself. Ever.
514 * @param obj object that would be "killed"
515 * @return a readable pipe descriptor, or -1 on error.
517 int __vlc_object_waitpipe( vlc_object_t *obj )
519 int pfd[2] = { -1, -1 };
520 vlc_object_internals_t *internals = vlc_internals( obj );
523 vlc_spin_lock (&internals->spin);
524 if (internals->pipes[0] == -1)
526 /* This can only ever happen if someone killed us without locking: */
527 assert (internals->pipes[1] == -1);
528 vlc_spin_unlock (&internals->spin);
533 vlc_spin_lock (&internals->spin);
534 if (internals->pipes[0] == -1)
536 internals->pipes[0] = pfd[0];
537 internals->pipes[1] = pfd[1];
538 pfd[0] = pfd[1] = -1;
542 vlc_spin_unlock (&internals->spin);
546 /* Race condition: vlc_object_kill() already invoked! */
549 vlc_spin_lock (&internals->spin);
550 fd = internals->pipes[1];
551 internals->pipes[1] = -1;
552 vlc_spin_unlock (&internals->spin);
554 msg_Dbg (obj, "waitpipe: object already dying");
559 /* Race condition: two threads call pipe() - unlikely */
565 return internals->pipes[0];
570 * Waits for the object to be signaled (using vlc_object_signal()).
571 * If the object already has a signal pending, this function will return
572 * immediately. It is asserted that the caller holds the object lock.
574 * @return true if the object is dying and should terminate.
576 bool __vlc_object_wait( vlc_object_t *obj )
578 vlc_assert_locked( &obj->object_lock );
579 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
585 * Waits for the object to be signaled (using vlc_object_signal()), or for
587 * If the object already has a signal pending, this function will return
588 * immediately. It is asserted that the caller holds the object lock.
590 * @return negative if the object is dying and should terminate,
591 * positive if the the object has been signaled but is not dying,
592 * 0 if timeout has been reached.
594 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
598 vlc_assert_locked( &obj->object_lock );
599 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
600 if( v == 0 ) /* signaled */
601 return obj->b_die ? -1 : 1;
607 * Checks whether an object has been "killed".
608 * The object lock must be held.
610 * Typical code for an object thread could be:
612 vlc_object_lock (self);
614 while (vlc_object_alive (self))
618 if (vlc_object_wait (self))
623 ...deinitialization...
624 vlc_object_unlock (self);
627 * @return true iff the object has not been killed yet
629 bool __vlc_object_alive( vlc_object_t *obj )
631 vlc_assert_locked( &obj->object_lock );
637 * Signals an object for which the lock is held.
639 void __vlc_object_signal_unlocked( vlc_object_t *obj )
641 vlc_assert_locked (&obj->object_lock);
642 vlc_cond_signal( &obj->object_wait );
647 * Requests termination of an object.
648 * If the object is LibVLC, also request to terminate all its children.
650 void __vlc_object_kill( vlc_object_t *p_this )
652 vlc_object_internals_t *internals = vlc_internals( p_this );
655 vlc_mutex_lock( &p_this->object_lock );
656 p_this->b_die = true;
658 vlc_spin_lock (&internals->spin);
659 fd = internals->pipes[1];
660 internals->pipes[1] = -1;
661 vlc_spin_unlock (&internals->spin);
665 msg_Dbg (p_this, "waitpipe: object killed");
669 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
670 for( int i = 0; i < p_this->i_children ; i++ )
671 vlc_object_kill( p_this->pp_children[i] );
673 vlc_object_signal_unlocked( p_this );
674 vlc_mutex_unlock( &p_this->object_lock );
679 * find an object given its ID
681 * This function looks for the object whose i_object_id field is i_id. We
682 * use a dichotomy so that lookups are in log2(n).
683 *****************************************************************************/
684 void * vlc_object_get( int i_id )
687 vlc_object_t **pp_objects;
688 libvlc_global_data_t *p_libvlc_global = vlc_global();
689 vlc_object_t *obj = NULL;
691 vlc_mutex_lock( &structure_lock );
693 pp_objects = p_libvlc_global->pp_objects;
695 /* Perform our dichotomy */
696 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
698 i_middle = i_max / 2;
700 if( pp_objects[i_middle]->i_object_id > i_id )
704 else if( pp_objects[i_middle]->i_object_id < i_id )
708 pp_objects += i_middle;
713 /* This happens when there are only two remaining objects */
714 if( pp_objects[i_middle+1]->i_object_id == i_id )
716 vlc_object_yield_locked( pp_objects[i_middle+1] );
717 obj = pp_objects[i_middle+1];
724 vlc_object_yield_locked( pp_objects[i_middle] );
725 vlc_mutex_unlock( &structure_lock );
726 return pp_objects[i_middle];
730 vlc_mutex_unlock( &structure_lock );
735 ****************************************************************************
736 * find a typed object and increment its refcount
737 *****************************************************************************
738 * This function recursively looks for a given object type. i_mode can be one
739 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
740 *****************************************************************************/
741 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
743 vlc_object_t *p_found;
745 vlc_mutex_lock( &structure_lock );
747 assert( vlc_internals( p_this )->i_refcount > 0 );
749 /* If we are of the requested type ourselves, don't look further */
750 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
752 vlc_object_yield_locked( p_this );
753 vlc_mutex_unlock( &structure_lock );
757 /* Otherwise, recursively look for the object */
758 if( (i_mode & 0x000f) == FIND_ANYWHERE )
760 vlc_object_t *p_root = p_this;
763 while( p_root->p_parent != NULL &&
764 p_root != VLC_OBJECT( p_this->p_libvlc ) )
766 p_root = p_root->p_parent;
769 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
770 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
772 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
773 i_type, (i_mode & ~0x000f)|FIND_CHILD );
778 p_found = FindObject( p_this, i_type, i_mode );
781 vlc_mutex_unlock( &structure_lock );
787 ****************************************************************************
788 * find a named object and increment its refcount
789 *****************************************************************************
790 * This function recursively looks for a given object name. i_mode can be one
791 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
792 *****************************************************************************/
793 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
796 vlc_object_t *p_found;
798 vlc_mutex_lock( &structure_lock );
800 /* Avoid obvious freed object uses */
801 assert( vlc_internals( p_this )->i_refcount > 0 );
803 /* If have the requested name ourselves, don't look further */
804 if( !(i_mode & FIND_STRICT)
805 && p_this->psz_object_name
806 && !strcmp( p_this->psz_object_name, psz_name ) )
808 vlc_object_yield_locked( p_this );
809 vlc_mutex_unlock( &structure_lock );
813 /* Otherwise, recursively look for the object */
814 if( (i_mode & 0x000f) == FIND_ANYWHERE )
816 vlc_object_t *p_root = p_this;
819 while( p_root->p_parent != NULL &&
820 p_root != VLC_OBJECT( p_this->p_libvlc ) )
822 p_root = p_root->p_parent;
825 p_found = FindObjectName( p_root, psz_name,
826 (i_mode & ~0x000f)|FIND_CHILD );
827 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
829 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
830 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
835 p_found = FindObjectName( p_this, psz_name, i_mode );
838 vlc_mutex_unlock( &structure_lock );
844 ****************************************************************************
845 * increment an object refcount
846 *****************************************************************************/
848 /* When the structure_lock is locked */
849 static void vlc_object_yield_locked( vlc_object_t *p_this )
851 vlc_assert_locked (&structure_lock);
853 /* Avoid obvious freed object uses */
854 assert( vlc_internals( p_this )->i_refcount > 0 );
856 /* Increment the counter */
857 vlc_internals( p_this )->i_refcount++;
860 /* Public function */
861 void __vlc_object_yield( vlc_object_t *p_this )
863 vlc_mutex_lock( &structure_lock );
864 vlc_object_yield_locked( p_this );
865 vlc_mutex_unlock( &structure_lock );
869 /*****************************************************************************
870 * decrement an object refcount
871 * And destroy the object if its refcount reach zero.
872 *****************************************************************************/
873 void __vlc_object_release( vlc_object_t *p_this )
875 bool b_should_destroy;
877 vlc_mutex_lock( &structure_lock );
879 assert( vlc_internals( p_this )->i_refcount > 0 );
880 vlc_internals( p_this )->i_refcount--;
881 b_should_destroy = (vlc_internals( p_this )->i_refcount == 0);
883 if( b_should_destroy )
885 /* Make sure this object can't be obtained via vlc_find_object now that
887 libvlc_global_data_t *p_libvlc_global = vlc_global();
890 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
891 * useless to try and recover anything if pp_objects gets smashed. */
892 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
893 p_libvlc_global->i_objects );
894 REMOVE_ELEM( p_libvlc_global->pp_objects,
895 p_libvlc_global->i_objects, i_index );
898 vlc_mutex_unlock( &structure_lock );
900 if( b_should_destroy )
901 vlc_object_destroy( p_this );
905 ****************************************************************************
906 * attach object to a parent object
907 *****************************************************************************
908 * This function sets p_this as a child of p_parent, and p_parent as a parent
909 * of p_this. This link can be undone using vlc_object_detach.
910 *****************************************************************************/
911 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
913 if( !p_this ) return;
915 vlc_mutex_lock( &structure_lock );
917 /* Avoid obvious freed object uses */
918 assert( vlc_internals( p_this )->i_refcount > 0 );
920 /* Attach the parent to its child */
921 p_this->p_parent = p_parent;
923 /* Attach the child to its parent */
924 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
925 p_parent->i_children, p_this );
927 /* Climb up the tree to see whether we are connected with the root */
928 if( vlc_internals( p_parent )->b_attached )
930 SetAttachment( p_this, true );
933 vlc_mutex_unlock( &structure_lock );
937 ****************************************************************************
938 * detach object from its parent
939 *****************************************************************************
940 * This function removes all links between an object and its parent.
941 *****************************************************************************/
942 void __vlc_object_detach( vlc_object_t *p_this )
944 if( !p_this ) return;
946 vlc_mutex_lock( &structure_lock );
948 if( !p_this->p_parent )
950 msg_Err( p_this, "object is not attached" );
951 vlc_mutex_unlock( &structure_lock );
955 /* Climb up the tree to see whether we are connected with the root */
956 if( vlc_internals( p_this->p_parent )->b_attached )
958 SetAttachment( p_this, false );
961 DetachObject( p_this );
962 vlc_mutex_unlock( &structure_lock );
967 ****************************************************************************
968 * find a list typed objects and increment their refcount
969 *****************************************************************************
970 * This function recursively looks for a given object type. i_mode can be one
971 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
972 *****************************************************************************/
973 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
976 vlc_object_t **pp_current, **pp_end;
977 int i_count = 0, i_index = 0;
978 libvlc_global_data_t *p_libvlc_global = vlc_global();
980 vlc_mutex_lock( &structure_lock );
982 /* Look for the objects */
983 switch( i_mode & 0x000f )
986 pp_current = p_libvlc_global->pp_objects;
987 pp_end = pp_current + p_libvlc_global->i_objects;
989 for( ; pp_current < pp_end ; pp_current++ )
991 if( vlc_internals(*pp_current)->b_attached
992 && (*pp_current)->i_object_type == i_type )
998 p_list = NewList( i_count );
999 pp_current = p_libvlc_global->pp_objects;
1001 for( ; pp_current < pp_end ; pp_current++ )
1003 if( vlc_internals(*pp_current)->b_attached
1004 && (*pp_current)->i_object_type == i_type )
1006 ListReplace( p_list, *pp_current, i_index );
1007 if( i_index < i_count ) i_index++;
1013 i_count = CountChildren( p_this, i_type );
1014 p_list = NewList( i_count );
1016 /* Check allocation was successful */
1017 if( p_list->i_count != i_count )
1019 msg_Err( p_this, "list allocation failed!" );
1020 p_list->i_count = 0;
1024 p_list->i_count = 0;
1025 ListChildren( p_list, p_this, i_type );
1029 msg_Err( p_this, "unimplemented!" );
1030 p_list = NewList( 0 );
1034 vlc_mutex_unlock( &structure_lock );
1039 /*****************************************************************************
1040 * DumpCommand: print the current vlc structure
1041 *****************************************************************************
1042 * This function prints either an ASCII tree showing the connections between
1043 * vlc objects, and additional information such as their refcount, thread ID,
1044 * etc. (command "tree"), or the same data as a simple list (command "list").
1045 *****************************************************************************/
1046 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1047 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1049 libvlc_global_data_t *p_libvlc_global = vlc_global();
1051 (void)oldval; (void)p_data;
1052 if( *psz_cmd == 'l' )
1054 vlc_mutex_lock( &structure_lock );
1056 vlc_object_t **pp_current, **pp_end;
1058 pp_current = p_libvlc_global->pp_objects;
1059 pp_end = pp_current + p_libvlc_global->i_objects;
1061 for( ; pp_current < pp_end ; pp_current++ )
1063 if( vlc_internals(*pp_current)->b_attached )
1065 PrintObject( *pp_current, "" );
1069 printf( " o %.8i %s (not attached)\n",
1070 (*pp_current)->i_object_id,
1071 (*pp_current)->psz_object_type );
1075 vlc_mutex_unlock( &structure_lock );
1079 vlc_object_t *p_object = NULL;
1081 if( *newval.psz_string )
1084 int i_id = strtol( newval.psz_string, &end, 0 );
1085 if( end != newval.psz_string )
1086 p_object = vlc_object_get( i_id );
1089 /* try using the object's name to find it */
1090 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1093 /* Look in p_libvlc's children tree */
1094 p_object = vlc_object_find_name( p_libvlc,
1097 vlc_object_release( p_libvlc );
1101 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1102 p_object = vlc_object_find_name( p_this,
1114 vlc_mutex_lock( &structure_lock );
1116 if( *psz_cmd == 't' )
1118 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1121 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1124 DumpStructure( p_object, 0, psz_foo );
1126 else if( *psz_cmd == 'v' )
1131 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1133 PrintObject( p_object, "" );
1135 if( !vlc_internals( p_object )->i_vars )
1136 printf( " `-o No variables\n" );
1137 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1139 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1141 const char *psz_type = "unknown";
1142 switch( p_var->i_type & VLC_VAR_TYPE )
1144 #define MYCASE( type, nice ) \
1145 case VLC_VAR_ ## type: \
1148 MYCASE( VOID, "void" );
1149 MYCASE( BOOL, "bool" );
1150 MYCASE( INTEGER, "integer" );
1151 MYCASE( HOTKEY, "hotkey" );
1152 MYCASE( STRING, "string" );
1153 MYCASE( MODULE, "module" );
1154 MYCASE( FILE, "file" );
1155 MYCASE( DIRECTORY, "directory" );
1156 MYCASE( VARIABLE, "variable" );
1157 MYCASE( FLOAT, "float" );
1158 MYCASE( TIME, "time" );
1159 MYCASE( ADDRESS, "address" );
1160 MYCASE( MUTEX, "mutex" );
1161 MYCASE( LIST, "list" );
1164 printf( " %c-o \"%s\" (%s",
1165 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1166 p_var->psz_name, psz_type );
1167 if( p_var->psz_text )
1168 printf( ", %s", p_var->psz_text );
1170 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1171 printf( ", command" );
1172 if( p_var->i_entries )
1173 printf( ", %d callbacks", p_var->i_entries );
1174 switch( p_var->i_type & 0x00f0 )
1180 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1182 case VLC_VAR_INTEGER:
1183 printf( ": %d", p_var->val.i_int );
1185 case VLC_VAR_STRING:
1186 printf( ": \"%s\"", p_var->val.psz_string );
1189 printf( ": %f", p_var->val.f_float );
1192 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1194 case VLC_VAR_ADDRESS:
1195 printf( ": %p", p_var->val.p_address );
1205 vlc_mutex_unlock( &structure_lock );
1207 if( *newval.psz_string )
1209 vlc_object_release( p_object );
1216 /*****************************************************************************
1217 * vlc_list_release: free a list previously allocated by vlc_list_find
1218 *****************************************************************************
1219 * This function decreases the refcount of all objects in the list and
1221 *****************************************************************************/
1222 void vlc_list_release( vlc_list_t *p_list )
1226 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1228 vlc_object_release( p_list->p_values[i_index].p_object );
1231 free( p_list->p_values );
1235 /*****************************************************************************
1236 * dump an object. (Debug function)
1237 *****************************************************************************/
1238 void __vlc_object_dump( vlc_object_t *p_this )
1240 vlc_mutex_lock( &structure_lock );
1241 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1243 DumpStructure( p_this, 0, psz_foo );
1244 vlc_mutex_unlock( &structure_lock );
1247 /* Following functions are local */
1249 /*****************************************************************************
1250 * FindIndex: find the index of an object in an array of objects
1251 *****************************************************************************
1252 * This function assumes that p_this can be found in pp_objects. It will not
1253 * crash if p_this cannot be found, but will return a wrong value. It is your
1254 * duty to check the return value if you are not certain that the object could
1255 * be found for sure.
1256 *****************************************************************************/
1257 static int FindIndex( vlc_object_t *p_this,
1258 vlc_object_t **pp_objects, int i_count )
1260 int i_middle = i_count / 2;
1267 if( pp_objects[i_middle] == p_this )
1277 /* We take advantage of the sorted array */
1278 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1280 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1281 i_count - i_middle );
1285 return FindIndex( p_this, pp_objects, i_middle );
1289 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1292 vlc_object_t *p_tmp;
1294 switch( i_mode & 0x000f )
1297 p_tmp = p_this->p_parent;
1300 if( p_tmp->i_object_type == i_type )
1302 vlc_object_yield_locked( p_tmp );
1307 return FindObject( p_tmp, i_type, i_mode );
1313 for( i = p_this->i_children; i--; )
1315 p_tmp = p_this->pp_children[i];
1316 if( p_tmp->i_object_type == i_type )
1318 vlc_object_yield_locked( p_tmp );
1321 else if( p_tmp->i_children )
1323 p_tmp = FindObject( p_tmp, i_type, i_mode );
1333 /* Handled in vlc_object_find */
1340 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1341 const char *psz_name,
1345 vlc_object_t *p_tmp;
1347 switch( i_mode & 0x000f )
1350 p_tmp = p_this->p_parent;
1353 if( p_tmp->psz_object_name
1354 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1356 vlc_object_yield_locked( p_tmp );
1361 return FindObjectName( p_tmp, psz_name, i_mode );
1367 for( i = p_this->i_children; i--; )
1369 p_tmp = p_this->pp_children[i];
1370 if( p_tmp->psz_object_name
1371 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1373 vlc_object_yield_locked( p_tmp );
1376 else if( p_tmp->i_children )
1378 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1388 /* Handled in vlc_object_find */
1395 static void DetachObject( vlc_object_t *p_this )
1397 vlc_object_t *p_parent = p_this->p_parent;
1400 /* Remove p_this's parent */
1401 p_this->p_parent = NULL;
1403 /* Remove all of p_parent's children which are p_this */
1404 for( i_index = p_parent->i_children ; i_index-- ; )
1406 if( p_parent->pp_children[i_index] == p_this )
1408 p_parent->i_children--;
1409 for( i = i_index ; i < p_parent->i_children ; i++ )
1411 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1416 if( p_parent->i_children )
1418 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1419 p_parent->i_children * sizeof(vlc_object_t *) );
1423 free( p_parent->pp_children );
1424 p_parent->pp_children = NULL;
1428 /*****************************************************************************
1429 * SetAttachment: recursively set the b_attached flag of a subtree.
1430 *****************************************************************************
1431 * This function is used by the attach and detach functions to propagate
1432 * the b_attached flag in a subtree.
1433 *****************************************************************************/
1434 static void SetAttachment( vlc_object_t *p_this, bool b_attached )
1438 for( i_index = p_this->i_children ; i_index-- ; )
1440 SetAttachment( p_this->pp_children[i_index], b_attached );
1443 vlc_internals( p_this )->b_attached = b_attached;
1446 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1448 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1451 memset( &psz_name, 0, sizeof(psz_name) );
1452 if( p_this->psz_object_name )
1454 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1456 psz_name[48] = '\"';
1459 psz_children[0] = '\0';
1460 switch( p_this->i_children )
1465 strcpy( psz_children, ", 1 child" );
1468 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1472 psz_refcount[0] = '\0';
1473 if( vlc_internals( p_this )->i_refcount > 0 )
1474 snprintf( psz_refcount, 19, ", refcount %u",
1475 vlc_internals( p_this )->i_refcount );
1477 psz_thread[0] = '\0';
1478 if( vlc_internals( p_this )->b_thread )
1479 snprintf( psz_thread, 29, " (thread %u)",
1480 #if defined(WIN32) || defined(UNDER_CE)
1481 (unsigned)vlc_internals( p_this )->thread_id.id );
1483 (unsigned)vlc_internals( p_this )->thread_id );
1486 psz_parent[0] = '\0';
1487 if( p_this->p_parent )
1488 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1490 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1491 p_this->i_object_id, p_this->psz_object_type,
1492 psz_name, psz_thread, psz_refcount, psz_children,
1496 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1499 char i_back = psz_foo[i_level];
1500 psz_foo[i_level] = '\0';
1502 PrintObject( p_this, psz_foo );
1504 psz_foo[i_level] = i_back;
1506 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1508 msg_Warn( p_this, "structure tree is too deep" );
1512 for( i = 0 ; i < p_this->i_children ; i++ )
1516 psz_foo[i_level-1] = ' ';
1518 if( psz_foo[i_level-2] == '`' )
1520 psz_foo[i_level-2] = ' ';
1524 if( i == p_this->i_children - 1 )
1526 psz_foo[i_level] = '`';
1530 psz_foo[i_level] = '|';
1533 psz_foo[i_level+1] = '-';
1534 psz_foo[i_level+2] = '\0';
1536 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1540 static vlc_list_t * NewList( int i_count )
1542 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1543 if( p_list == NULL )
1548 p_list->i_count = i_count;
1552 p_list->p_values = NULL;
1556 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1557 if( p_list->p_values == NULL )
1559 p_list->i_count = 0;
1566 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1569 if( p_list == NULL || i_index >= p_list->i_count )
1574 vlc_object_yield_locked( p_object );
1576 p_list->p_values[i_index].p_object = p_object;
1581 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1583 if( p_list == NULL )
1588 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1589 * sizeof( vlc_value_t ) );
1590 if( p_list->p_values == NULL )
1592 p_list->i_count = 0;
1596 vlc_object_yield_locked( p_object );
1598 p_list->p_values[p_list->i_count].p_object = p_object;
1604 static int CountChildren( vlc_object_t *p_this, int i_type )
1606 vlc_object_t *p_tmp;
1609 for( i = 0; i < p_this->i_children; i++ )
1611 p_tmp = p_this->pp_children[i];
1613 if( p_tmp->i_object_type == i_type )
1618 if( p_tmp->i_children )
1620 i_count += CountChildren( p_tmp, i_type );
1627 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1629 vlc_object_t *p_tmp;
1632 for( i = 0; i < p_this->i_children; i++ )
1634 p_tmp = p_this->pp_children[i];
1636 if( p_tmp->i_object_type == i_type )
1638 ListReplace( p_list, p_tmp, p_list->i_count++ );
1641 if( p_tmp->i_children )
1643 ListChildren( p_list, p_tmp, i_type );