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 *****************************************************************************/
36 # include <stdlib.h> /* realloc() */
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_playlist.h"
52 #include "vlc_interface.h"
53 #include "vlc_codec.h"
54 #include "vlc_filter.h"
56 #include "vlc_httpd.h"
58 #include "input/vlm_internal.h"
65 #include "variables.h"
67 /*****************************************************************************
69 *****************************************************************************/
70 static int DumpCommand( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
73 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
74 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
75 static void DetachObject ( vlc_object_t * );
76 static void PrintObject ( vlc_object_t *, const char * );
77 static void DumpStructure ( vlc_object_t *, int, char * );
78 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
79 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
81 static vlc_list_t * NewList ( int );
82 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
83 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
84 static int CountChildren ( vlc_object_t *, int );
85 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
87 /*****************************************************************************
88 * Local structure lock
89 *****************************************************************************/
90 static vlc_mutex_t structure_lock;
91 static vlc_object_internals_t global_internals;
93 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
94 int i_type, const char *psz_type )
97 vlc_object_internals_t *p_priv;
99 if( i_type == VLC_OBJECT_GLOBAL )
102 p_priv = &global_internals;
103 memset( p_priv, 0, sizeof( *p_priv ) );
107 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
111 p_new = (vlc_object_t *)(p_priv + 1);
114 p_new->p_internals = p_priv;
115 p_new->i_object_type = i_type;
116 p_new->psz_object_type = psz_type;
118 p_new->psz_object_name = NULL;
120 p_new->b_die = VLC_FALSE;
121 p_new->b_error = VLC_FALSE;
122 p_new->b_dead = VLC_FALSE;
123 p_new->b_attached = VLC_FALSE;
124 p_new->b_force = VLC_FALSE;
126 p_new->psz_header = NULL;
128 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
129 p_new->i_flags |= OBJECT_FLAGS_NODBG;
130 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
131 p_new->i_flags |= OBJECT_FLAGS_QUIET;
132 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
133 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
135 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
137 if( !p_priv->p_vars )
139 if( i_type != VLC_OBJECT_GLOBAL )
144 if( i_type == VLC_OBJECT_GLOBAL )
146 /* If i_type is global, then p_new is actually p_libvlc_global */
147 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
148 p_new->p_libvlc = NULL;
150 p_libvlc_global->i_counter = 0;
151 p_new->i_object_id = 0;
153 p_libvlc_global->i_objects = 1;
154 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
155 p_libvlc_global->pp_objects[0] = p_new;
156 p_new->b_attached = VLC_TRUE;
160 libvlc_global_data_t *p_libvlc_global = vlc_global();
161 p_new->p_libvlc = ( i_type == VLC_OBJECT_LIBVLC ) ? (libvlc_int_t*)p_new
164 vlc_mutex_lock( &structure_lock );
166 p_libvlc_global->i_counter++;
167 p_new->i_object_id = p_libvlc_global->i_counter;
169 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
170 * useless to try and recover anything if pp_objects gets smashed. */
171 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
174 vlc_mutex_unlock( &structure_lock );
177 p_new->i_refcount = 0;
178 p_new->p_parent = NULL;
179 p_new->pp_children = NULL;
180 p_new->i_children = 0;
182 p_new->p_private = NULL;
184 /* Initialize mutexes and condvars */
185 vlc_mutex_init( p_new, &p_new->object_lock );
186 vlc_cond_init( p_new, &p_new->object_wait );
187 vlc_mutex_init( p_new, &p_priv->var_lock );
189 if( i_type == VLC_OBJECT_GLOBAL )
191 vlc_mutex_init( p_new, &structure_lock );
193 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
194 var_AddCallback( p_new, "list", DumpCommand, NULL );
195 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
196 var_AddCallback( p_new, "tree", DumpCommand, NULL );
197 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
198 var_AddCallback( p_new, "vars", DumpCommand, NULL );
206 * Allocates and initializes a vlc object.
208 * @param i_type known object type (all of them are negative integer values),
209 * or object byte size (always positive).
211 * @return the new object, or NULL on error.
213 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
215 const char * psz_type;
220 case VLC_OBJECT_GLOBAL:
221 i_size = sizeof(libvlc_global_data_t);
224 case VLC_OBJECT_LIBVLC:
225 i_size = sizeof(libvlc_int_t);
228 case VLC_OBJECT_INTF:
229 i_size = sizeof(intf_thread_t);
230 psz_type = "interface";
232 case VLC_OBJECT_DIALOGS:
233 i_size = sizeof(intf_thread_t);
234 psz_type = "dialogs";
236 case VLC_OBJECT_PLAYLIST:
237 i_size = sizeof(playlist_t);
238 psz_type = "playlist";
241 i_size = sizeof(services_discovery_t);
242 psz_type = "services discovery";
244 case VLC_OBJECT_INPUT:
245 i_size = sizeof(input_thread_t);
248 case VLC_OBJECT_DEMUX:
249 i_size = sizeof(demux_t);
252 case VLC_OBJECT_ACCESS:
253 i_size = sizeof(access_t);
256 case VLC_OBJECT_DECODER:
257 i_size = sizeof(decoder_t);
258 psz_type = "decoder";
260 case VLC_OBJECT_PACKETIZER:
261 i_size = sizeof(decoder_t);
262 psz_type = "packetizer";
264 case VLC_OBJECT_ENCODER:
265 i_size = sizeof(encoder_t);
266 psz_type = "encoder";
268 case VLC_OBJECT_FILTER:
269 i_size = sizeof(filter_t);
272 case VLC_OBJECT_VOUT:
273 i_size = sizeof(vout_thread_t);
274 psz_type = "video output";
277 i_size = sizeof(spu_t);
278 psz_type = "subpicture";
280 case VLC_OBJECT_AOUT:
281 i_size = sizeof(aout_instance_t);
282 psz_type = "audio output";
284 case VLC_OBJECT_SOUT:
285 i_size = sizeof(sout_instance_t);
286 psz_type = "stream output";
289 i_size = sizeof( vlm_t );
290 psz_type = "vlm dameon";
293 i_size = sizeof( vod_t );
294 psz_type = "vod server";
297 i_size = sizeof( tls_t );
301 i_size = sizeof( xml_t );
304 case VLC_OBJECT_OPENGL:
305 i_size = sizeof( vout_thread_t );
308 case VLC_OBJECT_ANNOUNCE:
309 i_size = sizeof( announce_handler_t );
310 psz_type = "announce";
312 case VLC_OBJECT_META_ENGINE:
313 i_size = sizeof( meta_engine_t );
314 psz_type = "meta engine";
316 case VLC_OBJECT_OSDMENU:
317 i_size = sizeof( osd_menu_t );
318 psz_type = "osd menu";
321 i_size = i_type > (int)sizeof(vlc_object_t)
322 ? i_type : (int)sizeof(vlc_object_t);
323 i_type = VLC_OBJECT_GENERIC;
324 psz_type = "generic";
328 return vlc_custom_create( p_this, i_size, i_type, psz_type );
333 ****************************************************************************
334 * Destroy a vlc object
336 * This function destroys an object that has been previously allocated with
337 * vlc_object_create. The object's refcount must be zero and it must not be
338 * attached to other objects in any way.
339 *****************************************************************************/
340 void __vlc_object_destroy( vlc_object_t *p_this )
342 vlc_object_internals_t *p_priv = vlc_internals( p_this );
345 if( p_this->i_children )
347 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
348 p_this->i_object_id, p_this->psz_object_name );
352 if( p_this->p_parent )
354 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
355 p_this->i_object_id, p_this->psz_object_name );
359 while( p_this->i_refcount )
363 /* Don't warn immediately ... 100ms seems OK */
367 "refcount is %i, delaying before deletion (id=%d,type=%d)",
368 p_this->i_refcount, p_this->i_object_id,
369 p_this->i_object_type );
371 else if( i_delay == 10 )
374 "refcount is %i, delaying again (id=%d,type=%d)",
375 p_this->i_refcount, p_this->i_object_id,
376 p_this->i_object_type );
378 else if( i_delay == 20 )
381 "waited too long, cancelling destruction (id=%d,type=%d)",
382 p_this->i_object_id, p_this->i_object_type );
389 /* Destroy the associated variables, starting from the end so that
390 * no memmove calls have to be done. */
391 while( p_priv->i_vars )
393 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
396 free( p_priv->p_vars );
397 vlc_mutex_destroy( &p_priv->var_lock );
399 if( p_this->psz_header ) free( p_this->psz_header );
401 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
403 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
404 /* We are the global object ... no need to lock. */
405 free( p_global->pp_objects );
406 p_global->pp_objects = NULL;
407 p_global->i_objects--;
409 vlc_mutex_destroy( &structure_lock );
413 libvlc_global_data_t *p_libvlc_global = vlc_global();
416 vlc_mutex_lock( &structure_lock );
418 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
419 * useless to try and recover anything if pp_objects gets smashed. */
420 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
421 p_libvlc_global->i_objects );
422 REMOVE_ELEM( p_libvlc_global->pp_objects,
423 p_libvlc_global->i_objects, i_index );
425 vlc_mutex_unlock( &structure_lock );
428 vlc_mutex_destroy( &p_this->object_lock );
429 vlc_cond_destroy( &p_this->object_wait );
431 /* global is not dynamically allocated by vlc_object_create */
432 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
437 void __vlc_object_kill( vlc_object_t *p_this )
439 vlc_mutex_lock( &p_this->object_lock );
440 p_this->b_die = VLC_TRUE;
441 vlc_mutex_unlock( &p_this->object_lock );
445 vlc_bool_t __vlc_object_dying_unlocked( vlc_object_t *p_this )
447 vlc_assert_locked( &p_this->object_lock );
448 return p_this->b_die;
452 vlc_bool_t __vlc_object_dying( vlc_object_t *p_this )
455 vlc_mutex_lock( &p_this->object_lock );
456 b = __vlc_object_dying_unlocked( p_this );
457 vlc_mutex_unlock( &p_this->object_lock );
463 * find an object given its ID
465 * This function looks for the object whose i_object_id field is i_id. We
466 * use a dichotomy so that lookups are in log2(n).
467 *****************************************************************************/
468 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
471 vlc_object_t **pp_objects;
472 libvlc_global_data_t *p_libvlc_global = vlc_global();
474 vlc_mutex_lock( &structure_lock );
476 pp_objects = p_libvlc_global->pp_objects;
478 /* Perform our dichotomy */
479 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
481 i_middle = i_max / 2;
483 if( pp_objects[i_middle]->i_object_id > i_id )
487 else if( pp_objects[i_middle]->i_object_id < i_id )
491 pp_objects += i_middle;
496 /* This happens when there are only two remaining objects */
497 if( pp_objects[i_middle+1]->i_object_id == i_id )
499 vlc_mutex_unlock( &structure_lock );
500 pp_objects[i_middle+1]->i_refcount++;
501 return pp_objects[i_middle+1];
508 vlc_mutex_unlock( &structure_lock );
509 pp_objects[i_middle]->i_refcount++;
510 return pp_objects[i_middle];
515 /* this means that i_max == i_middle, and since we have already
516 * tested pp_objects[i_middle]), p_found is properly set. */
521 vlc_mutex_unlock( &structure_lock );
526 ****************************************************************************
527 * find a typed object and increment its refcount
528 *****************************************************************************
529 * This function recursively looks for a given object type. i_mode can be one
530 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
531 *****************************************************************************/
532 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
534 vlc_object_t *p_found;
536 vlc_mutex_lock( &structure_lock );
538 /* If we are of the requested type ourselves, don't look further */
539 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
541 p_this->i_refcount++;
542 vlc_mutex_unlock( &structure_lock );
546 /* Otherwise, recursively look for the object */
547 if( (i_mode & 0x000f) == FIND_ANYWHERE )
549 vlc_object_t *p_root = p_this;
552 while( p_root->p_parent != NULL &&
553 p_root != VLC_OBJECT( p_this->p_libvlc ) )
555 p_root = p_root->p_parent;
558 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
559 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
561 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
562 i_type, (i_mode & ~0x000f)|FIND_CHILD );
567 p_found = FindObject( p_this, i_type, i_mode );
570 vlc_mutex_unlock( &structure_lock );
576 ****************************************************************************
577 * find a named object and increment its refcount
578 *****************************************************************************
579 * This function recursively looks for a given object name. i_mode can be one
580 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
581 *****************************************************************************/
582 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
585 vlc_object_t *p_found;
587 vlc_mutex_lock( &structure_lock );
589 /* If have the requested name ourselves, don't look further */
590 if( !(i_mode & FIND_STRICT)
591 && p_this->psz_object_name
592 && !strcmp( p_this->psz_object_name, psz_name ) )
594 p_this->i_refcount++;
595 vlc_mutex_unlock( &structure_lock );
599 /* Otherwise, recursively look for the object */
600 if( (i_mode & 0x000f) == FIND_ANYWHERE )
602 vlc_object_t *p_root = p_this;
605 while( p_root->p_parent != NULL &&
606 p_root != VLC_OBJECT( p_this->p_libvlc ) )
608 p_root = p_root->p_parent;
611 p_found = FindObjectName( p_root, psz_name,
612 (i_mode & ~0x000f)|FIND_CHILD );
613 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
615 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
616 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
621 p_found = FindObjectName( p_this, psz_name, i_mode );
624 vlc_mutex_unlock( &structure_lock );
630 ****************************************************************************
631 * increment an object refcount
632 *****************************************************************************/
633 void __vlc_object_yield( vlc_object_t *p_this )
635 vlc_mutex_lock( &structure_lock );
636 p_this->i_refcount++;
637 vlc_mutex_unlock( &structure_lock );
641 ****************************************************************************
642 * decrement an object refcount
643 *****************************************************************************/
644 void __vlc_object_release( vlc_object_t *p_this )
646 vlc_mutex_lock( &structure_lock );
647 p_this->i_refcount--;
648 vlc_mutex_unlock( &structure_lock );
652 ****************************************************************************
653 * attach object to a parent object
654 *****************************************************************************
655 * This function sets p_this as a child of p_parent, and p_parent as a parent
656 * of p_this. This link can be undone using vlc_object_detach.
657 *****************************************************************************/
658 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
660 if( !p_this ) return;
662 vlc_mutex_lock( &structure_lock );
664 /* Attach the parent to its child */
665 p_this->p_parent = p_parent;
667 /* Attach the child to its parent */
668 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
669 p_parent->i_children, p_this );
671 /* Climb up the tree to see whether we are connected with the root */
672 if( p_parent->b_attached )
674 SetAttachment( p_this, VLC_TRUE );
677 vlc_mutex_unlock( &structure_lock );
681 ****************************************************************************
682 * detach object from its parent
683 *****************************************************************************
684 * This function removes all links between an object and its parent.
685 *****************************************************************************/
686 void __vlc_object_detach( vlc_object_t *p_this )
688 if( !p_this ) return;
690 vlc_mutex_lock( &structure_lock );
691 if( !p_this->p_parent )
693 msg_Err( p_this, "object is not attached" );
694 vlc_mutex_unlock( &structure_lock );
698 /* Climb up the tree to see whether we are connected with the root */
699 if( p_this->p_parent->b_attached )
701 SetAttachment( p_this, VLC_FALSE );
704 DetachObject( p_this );
705 vlc_mutex_unlock( &structure_lock );
710 ****************************************************************************
711 * find a list typed objects and increment their refcount
712 *****************************************************************************
713 * This function recursively looks for a given object type. i_mode can be one
714 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
715 *****************************************************************************/
716 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
719 vlc_object_t **pp_current, **pp_end;
720 int i_count = 0, i_index = 0;
721 libvlc_global_data_t *p_libvlc_global = vlc_global();
723 vlc_mutex_lock( &structure_lock );
725 /* Look for the objects */
726 switch( i_mode & 0x000f )
729 pp_current = p_libvlc_global->pp_objects;
730 pp_end = pp_current + p_libvlc_global->i_objects;
732 for( ; pp_current < pp_end ; pp_current++ )
734 if( (*pp_current)->b_attached
735 && (*pp_current)->i_object_type == i_type )
741 p_list = NewList( i_count );
742 pp_current = p_libvlc_global->pp_objects;
744 for( ; pp_current < pp_end ; pp_current++ )
746 if( (*pp_current)->b_attached
747 && (*pp_current)->i_object_type == i_type )
749 ListReplace( p_list, *pp_current, i_index );
750 if( i_index < i_count ) i_index++;
756 i_count = CountChildren( p_this, i_type );
757 p_list = NewList( i_count );
759 /* Check allocation was successful */
760 if( p_list->i_count != i_count )
762 msg_Err( p_this, "list allocation failed!" );
768 ListChildren( p_list, p_this, i_type );
772 msg_Err( p_this, "unimplemented!" );
773 p_list = NewList( 0 );
777 vlc_mutex_unlock( &structure_lock );
782 /*****************************************************************************
783 * DumpCommand: print the current vlc structure
784 *****************************************************************************
785 * This function prints either an ASCII tree showing the connections between
786 * vlc objects, and additional information such as their refcount, thread ID,
787 * etc. (command "tree"), or the same data as a simple list (command "list").
788 *****************************************************************************/
789 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
790 vlc_value_t oldval, vlc_value_t newval, void *p_data )
792 libvlc_global_data_t *p_libvlc_global = vlc_global();
794 (void)oldval; (void)p_data;
795 if( *psz_cmd == 'l' )
797 vlc_mutex_lock( &structure_lock );
799 vlc_object_t **pp_current, **pp_end;
801 pp_current = p_libvlc_global->pp_objects;
802 pp_end = pp_current + p_libvlc_global->i_objects;
804 for( ; pp_current < pp_end ; pp_current++ )
806 if( (*pp_current)->b_attached )
808 PrintObject( *pp_current, "" );
812 printf( " o %.8i %s (not attached)\n",
813 (*pp_current)->i_object_id,
814 (*pp_current)->psz_object_type );
818 vlc_mutex_unlock( &structure_lock );
822 vlc_object_t *p_object = NULL;
824 if( *newval.psz_string )
827 int i_id = strtol( newval.psz_string, &end, 0 );
828 if( end != newval.psz_string )
829 p_object = vlc_object_get( p_this, i_id );
832 /* try using the object's name to find it */
833 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
836 /* Look in p_libvlc's children tree */
837 p_object = vlc_object_find_name( p_libvlc,
840 vlc_object_release( p_libvlc );
844 /* If it's not in libvlc, look in libvlc_global (== p_this) */
845 p_object = vlc_object_find_name( p_this,
857 vlc_mutex_lock( &structure_lock );
859 if( *psz_cmd == 't' )
861 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
864 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
867 DumpStructure( p_object, 0, psz_foo );
869 else if( *psz_cmd == 'v' )
874 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
876 PrintObject( p_object, "" );
878 if( !p_object->p_internals->i_vars )
879 printf( " `-o No variables\n" );
880 for( i = 0; i < p_object->p_internals->i_vars; i++ )
882 variable_t *p_var = p_object->p_internals->p_vars + i;
884 const char *psz_type = "unknown";
885 switch( p_var->i_type & VLC_VAR_TYPE )
887 #define MYCASE( type, nice ) \
888 case VLC_VAR_ ## type: \
891 MYCASE( VOID, "void" );
892 MYCASE( BOOL, "bool" );
893 MYCASE( INTEGER, "integer" );
894 MYCASE( HOTKEY, "hotkey" );
895 MYCASE( STRING, "string" );
896 MYCASE( MODULE, "module" );
897 MYCASE( FILE, "file" );
898 MYCASE( DIRECTORY, "directory" );
899 MYCASE( VARIABLE, "variable" );
900 MYCASE( FLOAT, "float" );
901 MYCASE( TIME, "time" );
902 MYCASE( ADDRESS, "address" );
903 MYCASE( MUTEX, "mutex" );
904 MYCASE( LIST, "list" );
907 printf( " %c-o \"%s\" (%s",
908 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
909 p_var->psz_name, psz_type );
910 if( p_var->psz_text )
911 printf( ", %s", p_var->psz_text );
913 if( p_var->i_type & VLC_VAR_ISCOMMAND )
914 printf( ", command" );
915 if( p_var->i_entries )
916 printf( ", %d callbacks", p_var->i_entries );
917 switch( p_var->i_type & 0x00f0 )
923 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
925 case VLC_VAR_INTEGER:
926 printf( ": %d", p_var->val.i_int );
929 printf( ": \"%s\"", p_var->val.psz_string );
932 printf( ": %f", p_var->val.f_float );
935 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
937 case VLC_VAR_ADDRESS:
938 printf( ": %p", p_var->val.p_address );
948 vlc_mutex_unlock( &structure_lock );
950 if( *newval.psz_string )
952 vlc_object_release( p_object );
959 /*****************************************************************************
960 * vlc_list_release: free a list previously allocated by vlc_list_find
961 *****************************************************************************
962 * This function decreases the refcount of all objects in the list and
964 *****************************************************************************/
965 void vlc_list_release( vlc_list_t *p_list )
969 vlc_mutex_lock( &structure_lock );
970 for( i_index = 0; i_index < p_list->i_count; i_index++ )
972 p_list->p_values[i_index].p_object->i_refcount--;
974 vlc_mutex_unlock( &structure_lock );
976 free( p_list->p_values );
980 /* Following functions are local */
982 /*****************************************************************************
983 * FindIndex: find the index of an object in an array of objects
984 *****************************************************************************
985 * This function assumes that p_this can be found in pp_objects. It will not
986 * crash if p_this cannot be found, but will return a wrong value. It is your
987 * duty to check the return value if you are not certain that the object could
989 *****************************************************************************/
990 static int FindIndex( vlc_object_t *p_this,
991 vlc_object_t **pp_objects, int i_count )
993 int i_middle = i_count / 2;
1000 if( pp_objects[i_middle] == p_this )
1010 /* We take advantage of the sorted array */
1011 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1013 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1014 i_count - i_middle );
1018 return FindIndex( p_this, pp_objects, i_middle );
1022 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1025 vlc_object_t *p_tmp;
1027 switch( i_mode & 0x000f )
1030 p_tmp = p_this->p_parent;
1033 if( p_tmp->i_object_type == i_type )
1035 p_tmp->i_refcount++;
1040 return FindObject( p_tmp, i_type, i_mode );
1046 for( i = p_this->i_children; i--; )
1048 p_tmp = p_this->pp_children[i];
1049 if( p_tmp->i_object_type == i_type )
1051 p_tmp->i_refcount++;
1054 else if( p_tmp->i_children )
1056 p_tmp = FindObject( p_tmp, i_type, i_mode );
1066 /* Handled in vlc_object_find */
1073 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1074 const char *psz_name,
1078 vlc_object_t *p_tmp;
1080 switch( i_mode & 0x000f )
1083 p_tmp = p_this->p_parent;
1086 if( p_tmp->psz_object_name
1087 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1089 p_tmp->i_refcount++;
1094 return FindObjectName( p_tmp, psz_name, i_mode );
1100 for( i = p_this->i_children; i--; )
1102 p_tmp = p_this->pp_children[i];
1103 if( p_tmp->psz_object_name
1104 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1106 p_tmp->i_refcount++;
1109 else if( p_tmp->i_children )
1111 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1121 /* Handled in vlc_object_find */
1128 static void DetachObject( vlc_object_t *p_this )
1130 vlc_object_t *p_parent = p_this->p_parent;
1133 /* Remove p_this's parent */
1134 p_this->p_parent = NULL;
1136 /* Remove all of p_parent's children which are p_this */
1137 for( i_index = p_parent->i_children ; i_index-- ; )
1139 if( p_parent->pp_children[i_index] == p_this )
1141 p_parent->i_children--;
1142 for( i = i_index ; i < p_parent->i_children ; i++ )
1144 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1149 if( p_parent->i_children )
1151 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1152 p_parent->i_children * sizeof(vlc_object_t *) );
1156 free( p_parent->pp_children );
1157 p_parent->pp_children = NULL;
1161 /*****************************************************************************
1162 * SetAttachment: recursively set the b_attached flag of a subtree.
1163 *****************************************************************************
1164 * This function is used by the attach and detach functions to propagate
1165 * the b_attached flag in a subtree.
1166 *****************************************************************************/
1167 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1171 for( i_index = p_this->i_children ; i_index-- ; )
1173 SetAttachment( p_this->pp_children[i_index], b_attached );
1176 p_this->b_attached = b_attached;
1179 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1181 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1185 if( p_this->psz_object_name )
1187 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1189 psz_name[48] = '\"';
1192 psz_children[0] = '\0';
1193 switch( p_this->i_children )
1198 strcpy( psz_children, ", 1 child" );
1201 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1205 psz_refcount[0] = '\0';
1206 if( p_this->i_refcount )
1207 snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
1209 psz_thread[0] = '\0';
1210 if( p_this->b_thread )
1211 snprintf( psz_thread, 29, " (thread %d)", (int)p_this->thread_id );
1213 psz_parent[0] = '\0';
1214 if( p_this->p_parent )
1215 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1217 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1218 p_this->i_object_id, p_this->psz_object_type,
1219 psz_name, psz_thread, psz_refcount, psz_children,
1223 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1226 char i_back = psz_foo[i_level];
1227 psz_foo[i_level] = '\0';
1229 PrintObject( p_this, psz_foo );
1231 psz_foo[i_level] = i_back;
1233 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1235 msg_Warn( p_this, "structure tree is too deep" );
1239 for( i = 0 ; i < p_this->i_children ; i++ )
1243 psz_foo[i_level-1] = ' ';
1245 if( psz_foo[i_level-2] == '`' )
1247 psz_foo[i_level-2] = ' ';
1251 if( i == p_this->i_children - 1 )
1253 psz_foo[i_level] = '`';
1257 psz_foo[i_level] = '|';
1260 psz_foo[i_level+1] = '-';
1261 psz_foo[i_level+2] = '\0';
1263 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1267 static vlc_list_t * NewList( int i_count )
1269 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1270 if( p_list == NULL )
1275 p_list->i_count = i_count;
1279 p_list->p_values = NULL;
1283 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1284 if( p_list->p_values == NULL )
1286 p_list->i_count = 0;
1293 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1296 if( p_list == NULL || i_index >= p_list->i_count )
1301 p_object->i_refcount++;
1303 p_list->p_values[i_index].p_object = p_object;
1308 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1310 if( p_list == NULL )
1315 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1316 * sizeof( vlc_value_t ) );
1317 if( p_list->p_values == NULL )
1319 p_list->i_count = 0;
1323 p_object->i_refcount++;
1325 p_list->p_values[p_list->i_count].p_object = p_object;
1331 static int CountChildren( vlc_object_t *p_this, int i_type )
1333 vlc_object_t *p_tmp;
1336 for( i = 0; i < p_this->i_children; i++ )
1338 p_tmp = p_this->pp_children[i];
1340 if( p_tmp->i_object_type == i_type )
1345 if( p_tmp->i_children )
1347 i_count += CountChildren( p_tmp, i_type );
1354 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1356 vlc_object_t *p_tmp;
1359 for( i = 0; i < p_this->i_children; i++ )
1361 p_tmp = p_this->pp_children[i];
1363 if( p_tmp->i_object_type == i_type )
1365 ListReplace( p_list, p_tmp, p_list->i_count++ );
1368 if( p_tmp->i_children )
1370 ListChildren( p_list, p_tmp, i_type );