1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004-2007 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 *****************************************************************************/
35 #include "../libvlc.h"
38 #include "audio_output/aout_internal.h"
40 #include <vlc_access.h>
41 #include <vlc_demux.h>
42 #include <vlc_stream.h>
45 #include "stream_output/stream_output.h"
47 #include "vlc_playlist.h"
48 #include "vlc_interface.h"
49 #include "vlc_codec.h"
50 #include "vlc_filter.h"
52 #include "vlc_httpd.h"
54 #include "input/vlm_internal.h"
61 #include "variables.h"
69 /*****************************************************************************
71 *****************************************************************************/
72 static int DumpCommand( vlc_object_t *, char const *,
73 vlc_value_t, vlc_value_t, void * );
75 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
76 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
77 static void DetachObject ( vlc_object_t * );
78 static void PrintObject ( vlc_object_t *, const char * );
79 static void DumpStructure ( vlc_object_t *, int, char * );
80 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
81 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
83 static vlc_list_t * NewList ( int );
84 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
85 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
86 static int CountChildren ( vlc_object_t *, int );
87 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
89 /*****************************************************************************
90 * Local structure lock
91 *****************************************************************************/
92 static vlc_mutex_t structure_lock;
93 static vlc_object_internals_t global_internals;
95 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
96 int i_type, const char *psz_type )
99 vlc_object_internals_t *p_priv;
101 if( i_type == VLC_OBJECT_GLOBAL )
104 p_priv = &global_internals;
105 memset( p_priv, 0, sizeof( *p_priv ) );
109 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
113 p_new = (vlc_object_t *)(p_priv + 1);
116 p_new->p_internals = p_priv;
117 p_new->i_object_type = i_type;
118 p_new->psz_object_type = psz_type;
120 p_new->psz_object_name = NULL;
122 p_new->b_die = VLC_FALSE;
123 p_new->b_error = VLC_FALSE;
124 p_new->b_dead = VLC_FALSE;
125 p_priv->b_attached = VLC_FALSE;
126 p_new->b_force = VLC_FALSE;
128 p_new->psz_header = NULL;
130 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
131 p_new->i_flags |= OBJECT_FLAGS_NODBG;
132 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
133 p_new->i_flags |= OBJECT_FLAGS_QUIET;
134 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
135 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
137 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
139 if( !p_priv->p_vars )
141 if( i_type != VLC_OBJECT_GLOBAL )
146 if( i_type == VLC_OBJECT_GLOBAL )
148 /* If i_type is global, then p_new is actually p_libvlc_global */
149 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
150 p_new->p_libvlc = NULL;
152 p_libvlc_global->i_counter = 0;
153 p_new->i_object_id = 0;
155 p_libvlc_global->i_objects = 1;
156 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
157 p_libvlc_global->pp_objects[0] = p_new;
158 p_priv->b_attached = VLC_TRUE;
162 libvlc_global_data_t *p_libvlc_global = vlc_global();
163 if( i_type == VLC_OBJECT_LIBVLC )
165 p_new->p_libvlc = (libvlc_int_t*)p_new;
166 p_priv->b_attached = VLC_TRUE;
170 p_new->p_libvlc = p_this->p_libvlc;
173 vlc_mutex_lock( &structure_lock );
175 p_libvlc_global->i_counter++;
176 p_new->i_object_id = p_libvlc_global->i_counter;
178 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
179 * useless to try and recover anything if pp_objects gets smashed. */
180 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
183 vlc_mutex_unlock( &structure_lock );
186 p_priv->i_refcount = 0;
187 p_new->p_parent = NULL;
188 p_new->pp_children = NULL;
189 p_new->i_children = 0;
191 p_new->p_private = NULL;
193 /* Initialize mutexes and condvars */
194 vlc_mutex_init( p_new, &p_new->object_lock );
195 vlc_cond_init( p_new, &p_new->object_wait );
196 vlc_mutex_init( p_new, &p_priv->var_lock );
197 p_priv->pipes[0] = p_priv->pipes[1] = -1;
199 if( i_type == VLC_OBJECT_GLOBAL )
201 vlc_mutex_init( p_new, &structure_lock );
204 if( i_type == VLC_OBJECT_LIBVLC )
206 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
207 var_AddCallback( p_new, "list", DumpCommand, NULL );
208 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
209 var_AddCallback( p_new, "tree", DumpCommand, NULL );
210 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
211 var_AddCallback( p_new, "vars", DumpCommand, NULL );
219 * Allocates and initializes a vlc object.
221 * @param i_type known object type (all of them are negative integer values),
222 * or object byte size (always positive).
224 * @return the new object, or NULL on error.
226 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
228 const char * psz_type;
233 case VLC_OBJECT_GLOBAL:
234 i_size = sizeof(libvlc_global_data_t);
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_PLAYLIST:
250 i_size = sizeof(playlist_t);
251 psz_type = "playlist";
254 i_size = sizeof(services_discovery_t);
255 psz_type = "services discovery";
257 case VLC_OBJECT_INPUT:
258 i_size = sizeof(input_thread_t);
261 case VLC_OBJECT_DEMUX:
262 i_size = sizeof(demux_t);
265 case VLC_OBJECT_ACCESS:
266 i_size = sizeof(access_t);
269 case VLC_OBJECT_DECODER:
270 i_size = sizeof(decoder_t);
271 psz_type = "decoder";
273 case VLC_OBJECT_PACKETIZER:
274 i_size = sizeof(decoder_t);
275 psz_type = "packetizer";
277 case VLC_OBJECT_ENCODER:
278 i_size = sizeof(encoder_t);
279 psz_type = "encoder";
281 case VLC_OBJECT_FILTER:
282 i_size = sizeof(filter_t);
285 case VLC_OBJECT_VOUT:
286 i_size = sizeof(vout_thread_t);
287 psz_type = "video output";
290 i_size = sizeof(spu_t);
291 psz_type = "subpicture";
293 case VLC_OBJECT_AOUT:
294 i_size = sizeof(aout_instance_t);
295 psz_type = "audio output";
297 case VLC_OBJECT_SOUT:
298 i_size = sizeof(sout_instance_t);
299 psz_type = "stream output";
302 i_size = sizeof( vlm_t );
303 psz_type = "vlm dameon";
306 i_size = sizeof( vod_t );
307 psz_type = "vod server";
310 i_size = sizeof( xml_t );
313 case VLC_OBJECT_OPENGL:
314 i_size = sizeof( vout_thread_t );
317 case VLC_OBJECT_ANNOUNCE:
318 i_size = sizeof( announce_handler_t );
319 psz_type = "announce";
321 case VLC_OBJECT_META_ENGINE:
322 i_size = sizeof( meta_engine_t );
323 psz_type = "meta engine";
325 case VLC_OBJECT_OSDMENU:
326 i_size = sizeof( osd_menu_t );
327 psz_type = "osd menu";
330 i_size = i_type > (int)sizeof(vlc_object_t)
331 ? i_type : (int)sizeof(vlc_object_t);
332 i_type = VLC_OBJECT_GENERIC;
333 psz_type = "generic";
337 return vlc_custom_create( p_this, i_size, i_type, psz_type );
342 ****************************************************************************
343 * Destroy a vlc object
345 * This function destroys an object that has been previously allocated with
346 * vlc_object_create. The object's refcount must be zero and it must not be
347 * attached to other objects in any way.
348 *****************************************************************************/
349 void __vlc_object_destroy( vlc_object_t *p_this )
351 vlc_object_internals_t *p_priv = vlc_internals( p_this );
354 if( p_this->i_children )
356 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
357 p_this->i_object_id, p_this->psz_object_name );
361 if( p_this->p_parent )
363 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
364 p_this->i_object_id, p_this->psz_object_name );
368 while( p_priv->i_refcount > 0 )
372 /* Don't warn immediately ... 100ms seems OK */
376 "refcount is %u, delaying before deletion (id=%d,type=%d)",
377 p_priv->i_refcount, p_this->i_object_id,
378 p_this->i_object_type );
380 else if( i_delay == 10 )
383 "refcount is %u, delaying again (id=%d,type=%d)",
384 p_priv->i_refcount, p_this->i_object_id,
385 p_this->i_object_type );
387 else if( i_delay == 20 )
390 "waited too long, cancelling destruction (id=%d,type=%d)",
391 p_this->i_object_id, p_this->i_object_type );
398 /* Destroy the associated variables, starting from the end so that
399 * no memmove calls have to be done. */
400 while( p_priv->i_vars )
402 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
405 free( p_priv->p_vars );
406 vlc_mutex_destroy( &p_priv->var_lock );
408 if( p_this->psz_header ) free( p_this->psz_header );
410 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
412 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
413 /* We are the global object ... no need to lock. */
414 free( p_global->pp_objects );
415 p_global->pp_objects = NULL;
416 p_global->i_objects--;
418 vlc_mutex_destroy( &structure_lock );
422 libvlc_global_data_t *p_libvlc_global = vlc_global();
425 vlc_mutex_lock( &structure_lock );
427 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
428 * useless to try and recover anything if pp_objects gets smashed. */
429 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
430 p_libvlc_global->i_objects );
431 REMOVE_ELEM( p_libvlc_global->pp_objects,
432 p_libvlc_global->i_objects, i_index );
434 vlc_mutex_unlock( &structure_lock );
437 #if defined(WIN32) || defined(UNDER_CE)
438 /* if object has an associated thread, close it now */
439 if( p_priv->thread_id.hThread )
440 CloseHandle(p_priv->thread_id.hThread);
443 vlc_mutex_destroy( &p_this->object_lock );
444 vlc_cond_destroy( &p_this->object_wait );
445 if( p_priv->pipes[0] != -1 )
446 close( p_priv->pipes[0] );
447 if( p_priv->pipes[1] != -1 )
448 close( p_priv->pipes[1] );
450 /* global is not dynamically allocated by vlc_object_create */
451 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
456 /** Inter-object signaling */
458 void __vlc_object_lock( vlc_object_t *obj )
460 vlc_mutex_lock( &obj->object_lock );
463 void __vlc_object_unlock( vlc_object_t *obj )
465 vlc_assert_locked( &obj->object_lock );
466 vlc_mutex_unlock( &obj->object_lock );
470 * Returns the readable end of a pipe that becomes readable whenever
471 * an object is signaled. This can be used to wait for VLC object events
472 * inside select(), poll() loops or frameworks providing an event loop.
474 * Note that the pipe will remain the same for the lifetime of the object.
475 * DO NOT close it yourself. Ever.
477 * DO NOT try to read from the pipe either: call vlc_object_wait() instead.
478 * Assuming the pipe is readable, vlc_object_wait() will not block.
479 * Also note that, as with vlc_object_wait(), there may be spurious wakeups.
481 * @param obj object that would be signaled (object lock MUST hold)
482 * @return a readable pipe descriptor, or -1 on error.
484 int vlc_object_waitpipe( vlc_object_t *obj )
486 int *pipes = obj->p_internals->pipes;
487 vlc_assert_locked( &obj->object_lock );
491 /* This can only ever happen if someone killed us without locking */
492 assert( pipes[0] == -1 );
497 if( _pipe( pipes, 1, _O_BINARY ) )
507 * Waits for the object to be signaled (using vlc_object_signal()).
508 * If the object already has a signal pending, this function will return
509 * immediately. It is asserted that the caller holds the object lock.
511 * @return true if the object is dying and should terminate.
513 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
515 vlc_assert_locked( &obj->object_lock );
517 int fd = obj->p_internals->pipes[0];
520 if( read( fd, &(char){ 0 }, 1 ) == 0 )
523 obj->p_internals->pipes[1] = -1;
528 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
534 * Waits for the object to be signaled (using vlc_object_signal()), or for
536 * If the object already has a signal pending, this function will return
537 * immediately. It is asserted that the caller holds the object lock.
539 * @return negative if the object is dying and should terminate,
540 * positive if the the object has been signaled but is not dying,
541 * 0 if timeout has been reached.
543 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
547 vlc_assert_locked( &obj->object_lock );
548 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
549 if( v == 0 ) /* signaled */
550 return obj->b_die ? -1 : 1;
556 * Signals an object for which the lock is held.
558 void __vlc_object_signal_unlocked( vlc_object_t *obj )
560 vlc_assert_locked( &obj->object_lock );
562 int fd = obj->p_internals->pipes[1];
564 while( write( fd, &(char){ 0 }, 1 ) < 0 );
566 vlc_cond_signal( &obj->object_wait );
571 * Requests termination of an object.
572 * If the object is LibVLC, also request to terminate all its children.
574 void __vlc_object_kill( vlc_object_t *p_this )
576 vlc_mutex_lock( &p_this->object_lock );
577 p_this->b_die = VLC_TRUE;
579 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
580 for( int i = 0; i < p_this->i_children ; i++ )
581 vlc_object_kill( p_this->pp_children[i] );
583 int fd = p_this->p_internals->pipes[1];
586 close( fd ); /* closing a pipe makes it readable too */
587 p_this->p_internals->pipes[1] = -1;
590 vlc_object_signal_unlocked( p_this );
591 vlc_mutex_unlock( &p_this->object_lock );
596 * find an object given its ID
598 * This function looks for the object whose i_object_id field is i_id. We
599 * use a dichotomy so that lookups are in log2(n).
600 *****************************************************************************/
601 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
604 vlc_object_t **pp_objects;
605 libvlc_global_data_t *p_libvlc_global = vlc_global();
607 vlc_mutex_lock( &structure_lock );
609 pp_objects = p_libvlc_global->pp_objects;
611 /* Perform our dichotomy */
612 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
614 i_middle = i_max / 2;
616 if( pp_objects[i_middle]->i_object_id > i_id )
620 else if( pp_objects[i_middle]->i_object_id < i_id )
624 pp_objects += i_middle;
629 /* This happens when there are only two remaining objects */
630 if( pp_objects[i_middle+1]->i_object_id == i_id )
632 vlc_mutex_unlock( &structure_lock );
633 pp_objects[i_middle+1]->p_internals->i_refcount++;
634 return pp_objects[i_middle+1];
641 vlc_mutex_unlock( &structure_lock );
642 pp_objects[i_middle]->p_internals->i_refcount++;
643 return pp_objects[i_middle];
648 /* this means that i_max == i_middle, and since we have already
649 * tested pp_objects[i_middle]), p_found is properly set. */
654 vlc_mutex_unlock( &structure_lock );
659 ****************************************************************************
660 * find a typed object and increment its refcount
661 *****************************************************************************
662 * This function recursively looks for a given object type. i_mode can be one
663 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
664 *****************************************************************************/
665 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
667 vlc_object_t *p_found;
669 vlc_mutex_lock( &structure_lock );
671 /* If we are of the requested type ourselves, don't look further */
672 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
674 p_this->p_internals->i_refcount++;
675 vlc_mutex_unlock( &structure_lock );
679 /* Otherwise, recursively look for the object */
680 if( (i_mode & 0x000f) == FIND_ANYWHERE )
682 vlc_object_t *p_root = p_this;
685 while( p_root->p_parent != NULL &&
686 p_root != VLC_OBJECT( p_this->p_libvlc ) )
688 p_root = p_root->p_parent;
691 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
692 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
694 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
695 i_type, (i_mode & ~0x000f)|FIND_CHILD );
700 p_found = FindObject( p_this, i_type, i_mode );
703 vlc_mutex_unlock( &structure_lock );
709 ****************************************************************************
710 * find a named object and increment its refcount
711 *****************************************************************************
712 * This function recursively looks for a given object name. i_mode can be one
713 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
714 *****************************************************************************/
715 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
718 vlc_object_t *p_found;
720 vlc_mutex_lock( &structure_lock );
722 /* If have the requested name ourselves, don't look further */
723 if( !(i_mode & FIND_STRICT)
724 && p_this->psz_object_name
725 && !strcmp( p_this->psz_object_name, psz_name ) )
727 p_this->p_internals->i_refcount++;
728 vlc_mutex_unlock( &structure_lock );
732 /* Otherwise, recursively look for the object */
733 if( (i_mode & 0x000f) == FIND_ANYWHERE )
735 vlc_object_t *p_root = p_this;
738 while( p_root->p_parent != NULL &&
739 p_root != VLC_OBJECT( p_this->p_libvlc ) )
741 p_root = p_root->p_parent;
744 p_found = FindObjectName( p_root, psz_name,
745 (i_mode & ~0x000f)|FIND_CHILD );
746 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
748 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
749 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
754 p_found = FindObjectName( p_this, psz_name, i_mode );
757 vlc_mutex_unlock( &structure_lock );
763 ****************************************************************************
764 * increment an object refcount
765 *****************************************************************************/
766 void __vlc_object_yield( vlc_object_t *p_this )
768 vlc_mutex_lock( &structure_lock );
769 p_this->p_internals->i_refcount++;
770 vlc_mutex_unlock( &structure_lock );
773 static inline void Release( vlc_object_t *obj )
775 assert( obj->p_internals->i_refcount > 0 );
776 obj->p_internals->i_refcount--;
779 /*****************************************************************************
780 * decrement an object refcount
781 *****************************************************************************/
782 void __vlc_object_release( vlc_object_t *p_this )
784 vlc_mutex_lock( &structure_lock );
786 vlc_mutex_unlock( &structure_lock );
790 ****************************************************************************
791 * attach object to a parent object
792 *****************************************************************************
793 * This function sets p_this as a child of p_parent, and p_parent as a parent
794 * of p_this. This link can be undone using vlc_object_detach.
795 *****************************************************************************/
796 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
798 if( !p_this ) return;
800 vlc_mutex_lock( &structure_lock );
802 /* Attach the parent to its child */
803 p_this->p_parent = p_parent;
805 /* Attach the child to its parent */
806 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
807 p_parent->i_children, p_this );
809 /* Climb up the tree to see whether we are connected with the root */
810 if( p_parent->p_internals->b_attached )
812 SetAttachment( p_this, VLC_TRUE );
815 vlc_mutex_unlock( &structure_lock );
819 ****************************************************************************
820 * detach object from its parent
821 *****************************************************************************
822 * This function removes all links between an object and its parent.
823 *****************************************************************************/
824 void __vlc_object_detach( vlc_object_t *p_this )
826 if( !p_this ) return;
828 vlc_mutex_lock( &structure_lock );
829 if( !p_this->p_parent )
831 msg_Err( p_this, "object is not attached" );
832 vlc_mutex_unlock( &structure_lock );
836 /* Climb up the tree to see whether we are connected with the root */
837 if( p_this->p_parent->p_internals->b_attached )
839 SetAttachment( p_this, VLC_FALSE );
842 DetachObject( p_this );
843 vlc_mutex_unlock( &structure_lock );
848 ****************************************************************************
849 * find a list typed objects and increment their refcount
850 *****************************************************************************
851 * This function recursively looks for a given object type. i_mode can be one
852 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
853 *****************************************************************************/
854 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
857 vlc_object_t **pp_current, **pp_end;
858 int i_count = 0, i_index = 0;
859 libvlc_global_data_t *p_libvlc_global = vlc_global();
861 vlc_mutex_lock( &structure_lock );
863 /* Look for the objects */
864 switch( i_mode & 0x000f )
867 pp_current = p_libvlc_global->pp_objects;
868 pp_end = pp_current + p_libvlc_global->i_objects;
870 for( ; pp_current < pp_end ; pp_current++ )
872 if( (*pp_current)->p_internals->b_attached
873 && (*pp_current)->i_object_type == i_type )
879 p_list = NewList( i_count );
880 pp_current = p_libvlc_global->pp_objects;
882 for( ; pp_current < pp_end ; pp_current++ )
884 if( (*pp_current)->p_internals->b_attached
885 && (*pp_current)->i_object_type == i_type )
887 ListReplace( p_list, *pp_current, i_index );
888 if( i_index < i_count ) i_index++;
894 i_count = CountChildren( p_this, i_type );
895 p_list = NewList( i_count );
897 /* Check allocation was successful */
898 if( p_list->i_count != i_count )
900 msg_Err( p_this, "list allocation failed!" );
906 ListChildren( p_list, p_this, i_type );
910 msg_Err( p_this, "unimplemented!" );
911 p_list = NewList( 0 );
915 vlc_mutex_unlock( &structure_lock );
920 /*****************************************************************************
921 * DumpCommand: print the current vlc structure
922 *****************************************************************************
923 * This function prints either an ASCII tree showing the connections between
924 * vlc objects, and additional information such as their refcount, thread ID,
925 * etc. (command "tree"), or the same data as a simple list (command "list").
926 *****************************************************************************/
927 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
928 vlc_value_t oldval, vlc_value_t newval, void *p_data )
930 libvlc_global_data_t *p_libvlc_global = vlc_global();
932 (void)oldval; (void)p_data;
933 if( *psz_cmd == 'l' )
935 vlc_mutex_lock( &structure_lock );
937 vlc_object_t **pp_current, **pp_end;
939 pp_current = p_libvlc_global->pp_objects;
940 pp_end = pp_current + p_libvlc_global->i_objects;
942 for( ; pp_current < pp_end ; pp_current++ )
944 if( (*pp_current)->p_internals->b_attached )
946 PrintObject( *pp_current, "" );
950 printf( " o %.8i %s (not attached)\n",
951 (*pp_current)->i_object_id,
952 (*pp_current)->psz_object_type );
956 vlc_mutex_unlock( &structure_lock );
960 vlc_object_t *p_object = NULL;
962 if( *newval.psz_string )
965 int i_id = strtol( newval.psz_string, &end, 0 );
966 if( end != newval.psz_string )
967 p_object = vlc_object_get( p_this, i_id );
970 /* try using the object's name to find it */
971 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
974 /* Look in p_libvlc's children tree */
975 p_object = vlc_object_find_name( p_libvlc,
978 vlc_object_release( p_libvlc );
982 /* If it's not in libvlc, look in libvlc_global (== p_this) */
983 p_object = vlc_object_find_name( p_this,
995 vlc_mutex_lock( &structure_lock );
997 if( *psz_cmd == 't' )
999 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1002 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1005 DumpStructure( p_object, 0, psz_foo );
1007 else if( *psz_cmd == 'v' )
1012 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1014 PrintObject( p_object, "" );
1016 if( !p_object->p_internals->i_vars )
1017 printf( " `-o No variables\n" );
1018 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1020 variable_t *p_var = p_object->p_internals->p_vars + i;
1022 const char *psz_type = "unknown";
1023 switch( p_var->i_type & VLC_VAR_TYPE )
1025 #define MYCASE( type, nice ) \
1026 case VLC_VAR_ ## type: \
1029 MYCASE( VOID, "void" );
1030 MYCASE( BOOL, "bool" );
1031 MYCASE( INTEGER, "integer" );
1032 MYCASE( HOTKEY, "hotkey" );
1033 MYCASE( STRING, "string" );
1034 MYCASE( MODULE, "module" );
1035 MYCASE( FILE, "file" );
1036 MYCASE( DIRECTORY, "directory" );
1037 MYCASE( VARIABLE, "variable" );
1038 MYCASE( FLOAT, "float" );
1039 MYCASE( TIME, "time" );
1040 MYCASE( ADDRESS, "address" );
1041 MYCASE( MUTEX, "mutex" );
1042 MYCASE( LIST, "list" );
1045 printf( " %c-o \"%s\" (%s",
1046 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1047 p_var->psz_name, psz_type );
1048 if( p_var->psz_text )
1049 printf( ", %s", p_var->psz_text );
1051 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1052 printf( ", command" );
1053 if( p_var->i_entries )
1054 printf( ", %d callbacks", p_var->i_entries );
1055 switch( p_var->i_type & 0x00f0 )
1061 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1063 case VLC_VAR_INTEGER:
1064 printf( ": %d", p_var->val.i_int );
1066 case VLC_VAR_STRING:
1067 printf( ": \"%s\"", p_var->val.psz_string );
1070 printf( ": %f", p_var->val.f_float );
1073 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1075 case VLC_VAR_ADDRESS:
1076 printf( ": %p", p_var->val.p_address );
1086 vlc_mutex_unlock( &structure_lock );
1088 if( *newval.psz_string )
1090 vlc_object_release( p_object );
1097 /*****************************************************************************
1098 * vlc_list_release: free a list previously allocated by vlc_list_find
1099 *****************************************************************************
1100 * This function decreases the refcount of all objects in the list and
1102 *****************************************************************************/
1103 void vlc_list_release( vlc_list_t *p_list )
1107 vlc_mutex_lock( &structure_lock );
1108 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1110 Release( p_list->p_values[i_index].p_object );
1112 vlc_mutex_unlock( &structure_lock );
1114 free( p_list->p_values );
1118 /* Following functions are local */
1120 /*****************************************************************************
1121 * FindIndex: find the index of an object in an array of objects
1122 *****************************************************************************
1123 * This function assumes that p_this can be found in pp_objects. It will not
1124 * crash if p_this cannot be found, but will return a wrong value. It is your
1125 * duty to check the return value if you are not certain that the object could
1126 * be found for sure.
1127 *****************************************************************************/
1128 static int FindIndex( vlc_object_t *p_this,
1129 vlc_object_t **pp_objects, int i_count )
1131 int i_middle = i_count / 2;
1138 if( pp_objects[i_middle] == p_this )
1148 /* We take advantage of the sorted array */
1149 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1151 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1152 i_count - i_middle );
1156 return FindIndex( p_this, pp_objects, i_middle );
1160 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1163 vlc_object_t *p_tmp;
1165 switch( i_mode & 0x000f )
1168 p_tmp = p_this->p_parent;
1171 if( p_tmp->i_object_type == i_type )
1173 p_tmp->p_internals->i_refcount++;
1178 return FindObject( p_tmp, i_type, i_mode );
1184 for( i = p_this->i_children; i--; )
1186 p_tmp = p_this->pp_children[i];
1187 if( p_tmp->i_object_type == i_type )
1189 p_tmp->p_internals->i_refcount++;
1192 else if( p_tmp->i_children )
1194 p_tmp = FindObject( p_tmp, i_type, i_mode );
1204 /* Handled in vlc_object_find */
1211 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1212 const char *psz_name,
1216 vlc_object_t *p_tmp;
1218 switch( i_mode & 0x000f )
1221 p_tmp = p_this->p_parent;
1224 if( p_tmp->psz_object_name
1225 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1227 p_tmp->p_internals->i_refcount++;
1232 return FindObjectName( p_tmp, psz_name, i_mode );
1238 for( i = p_this->i_children; i--; )
1240 p_tmp = p_this->pp_children[i];
1241 if( p_tmp->psz_object_name
1242 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1244 p_tmp->p_internals->i_refcount++;
1247 else if( p_tmp->i_children )
1249 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1259 /* Handled in vlc_object_find */
1266 static void DetachObject( vlc_object_t *p_this )
1268 vlc_object_t *p_parent = p_this->p_parent;
1271 /* Remove p_this's parent */
1272 p_this->p_parent = NULL;
1274 /* Remove all of p_parent's children which are p_this */
1275 for( i_index = p_parent->i_children ; i_index-- ; )
1277 if( p_parent->pp_children[i_index] == p_this )
1279 p_parent->i_children--;
1280 for( i = i_index ; i < p_parent->i_children ; i++ )
1282 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1287 if( p_parent->i_children )
1289 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1290 p_parent->i_children * sizeof(vlc_object_t *) );
1294 free( p_parent->pp_children );
1295 p_parent->pp_children = NULL;
1299 /*****************************************************************************
1300 * SetAttachment: recursively set the b_attached flag of a subtree.
1301 *****************************************************************************
1302 * This function is used by the attach and detach functions to propagate
1303 * the b_attached flag in a subtree.
1304 *****************************************************************************/
1305 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1309 for( i_index = p_this->i_children ; i_index-- ; )
1311 SetAttachment( p_this->pp_children[i_index], b_attached );
1314 p_this->p_internals->b_attached = b_attached;
1317 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1319 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1323 if( p_this->psz_object_name )
1325 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1327 psz_name[48] = '\"';
1330 psz_children[0] = '\0';
1331 switch( p_this->i_children )
1336 strcpy( psz_children, ", 1 child" );
1339 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1343 psz_refcount[0] = '\0';
1344 if( p_this->p_internals->i_refcount > 0 )
1345 snprintf( psz_refcount, 19, ", refcount %u",
1346 p_this->p_internals->i_refcount );
1348 psz_thread[0] = '\0';
1349 if( p_this->p_internals->b_thread )
1350 snprintf( psz_thread, 29, " (thread %u)",
1351 #if defined(WIN32) || defined(UNDER_CE)
1352 (unsigned)p_this->p_internals->thread_id.id );
1354 (unsigned)p_this->p_internals->thread_id );
1357 psz_parent[0] = '\0';
1358 if( p_this->p_parent )
1359 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1361 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1362 p_this->i_object_id, p_this->psz_object_type,
1363 psz_name, psz_thread, psz_refcount, psz_children,
1367 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1370 char i_back = psz_foo[i_level];
1371 psz_foo[i_level] = '\0';
1373 PrintObject( p_this, psz_foo );
1375 psz_foo[i_level] = i_back;
1377 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1379 msg_Warn( p_this, "structure tree is too deep" );
1383 for( i = 0 ; i < p_this->i_children ; i++ )
1387 psz_foo[i_level-1] = ' ';
1389 if( psz_foo[i_level-2] == '`' )
1391 psz_foo[i_level-2] = ' ';
1395 if( i == p_this->i_children - 1 )
1397 psz_foo[i_level] = '`';
1401 psz_foo[i_level] = '|';
1404 psz_foo[i_level+1] = '-';
1405 psz_foo[i_level+2] = '\0';
1407 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1411 static vlc_list_t * NewList( int i_count )
1413 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1414 if( p_list == NULL )
1419 p_list->i_count = i_count;
1423 p_list->p_values = NULL;
1427 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1428 if( p_list->p_values == NULL )
1430 p_list->i_count = 0;
1437 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1440 if( p_list == NULL || i_index >= p_list->i_count )
1445 p_object->p_internals->i_refcount++;
1447 p_list->p_values[i_index].p_object = p_object;
1452 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1454 if( p_list == NULL )
1459 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1460 * sizeof( vlc_value_t ) );
1461 if( p_list->p_values == NULL )
1463 p_list->i_count = 0;
1467 p_object->p_internals->i_refcount++;
1469 p_list->p_values[p_list->i_count].p_object = p_object;
1475 static int CountChildren( vlc_object_t *p_this, int i_type )
1477 vlc_object_t *p_tmp;
1480 for( i = 0; i < p_this->i_children; i++ )
1482 p_tmp = p_this->pp_children[i];
1484 if( p_tmp->i_object_type == i_type )
1489 if( p_tmp->i_children )
1491 i_count += CountChildren( p_tmp, i_type );
1498 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1500 vlc_object_t *p_tmp;
1503 for( i = 0; i < p_this->i_children; i++ )
1505 p_tmp = p_this->pp_children[i];
1507 if( p_tmp->i_object_type == i_type )
1509 ListReplace( p_list, p_tmp, p_list->i_count++ );
1512 if( p_tmp->i_children )
1514 ListChildren( p_list, p_tmp, i_type );