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;
129 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
130 p_new->i_flags |= OBJECT_FLAGS_NODBG;
131 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
132 p_new->i_flags |= OBJECT_FLAGS_QUIET;
133 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
134 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
137 p_new->p_vars = (variable_t *)malloc( 16 * sizeof( variable_t ) );
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_global = p_new;
151 p_new->p_libvlc = NULL;
153 p_libvlc_global->i_counter = 0;
154 p_new->i_object_id = 0;
156 p_libvlc_global->i_objects = 1;
157 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
158 p_libvlc_global->pp_objects[0] = p_new;
159 p_new->b_attached = VLC_TRUE;
163 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
164 p_new->p_libvlc_global = VLC_OBJECT (p_libvlc_global);
165 p_new->p_libvlc = ( i_type == VLC_OBJECT_LIBVLC ) ? (libvlc_int_t*)p_new
168 vlc_mutex_lock( &structure_lock );
170 p_libvlc_global->i_counter++;
171 p_new->i_object_id = p_libvlc_global->i_counter;
173 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
174 * useless to try and recover anything if pp_objects gets smashed. */
175 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
178 vlc_mutex_unlock( &structure_lock );
181 p_new->i_refcount = 0;
182 p_new->p_parent = NULL;
183 p_new->pp_children = NULL;
184 p_new->i_children = 0;
186 p_new->p_private = NULL;
188 /* Initialize mutexes and condvars */
189 vlc_mutex_init( p_new, &p_new->object_lock );
190 vlc_cond_init( p_new, &p_new->object_wait );
191 vlc_mutex_init( p_new, &p_new->var_lock );
193 if( i_type == VLC_OBJECT_GLOBAL )
195 vlc_mutex_init( p_new, &structure_lock );
197 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
198 var_AddCallback( p_new, "list", DumpCommand, NULL );
199 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
200 var_AddCallback( p_new, "tree", DumpCommand, NULL );
201 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
202 var_AddCallback( p_new, "vars", DumpCommand, NULL );
210 * Allocates and initializes a vlc object.
212 * @param i_type known object type (all of them are negative integer values),
213 * or object byte size (always positive).
215 * @return the new object, or NULL on error.
217 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
219 const char * psz_type;
224 case VLC_OBJECT_GLOBAL:
225 i_size = sizeof(libvlc_global_data_t);
228 case VLC_OBJECT_LIBVLC:
229 i_size = sizeof(libvlc_int_t);
232 case VLC_OBJECT_INTF:
233 i_size = sizeof(intf_thread_t);
234 psz_type = "interface";
236 case VLC_OBJECT_DIALOGS:
237 i_size = sizeof(intf_thread_t);
238 psz_type = "dialogs";
240 case VLC_OBJECT_PLAYLIST:
241 i_size = sizeof(playlist_t);
242 psz_type = "playlist";
245 i_size = sizeof(services_discovery_t);
246 psz_type = "services discovery";
248 case VLC_OBJECT_INPUT:
249 i_size = sizeof(input_thread_t);
252 case VLC_OBJECT_DEMUX:
253 i_size = sizeof(demux_t);
256 case VLC_OBJECT_ACCESS:
257 i_size = sizeof(access_t);
260 case VLC_OBJECT_DECODER:
261 i_size = sizeof(decoder_t);
262 psz_type = "decoder";
264 case VLC_OBJECT_PACKETIZER:
265 i_size = sizeof(decoder_t);
266 psz_type = "packetizer";
268 case VLC_OBJECT_ENCODER:
269 i_size = sizeof(encoder_t);
270 psz_type = "encoder";
272 case VLC_OBJECT_FILTER:
273 i_size = sizeof(filter_t);
276 case VLC_OBJECT_VOUT:
277 i_size = sizeof(vout_thread_t);
278 psz_type = "video output";
281 i_size = sizeof(spu_t);
282 psz_type = "subpicture";
284 case VLC_OBJECT_AOUT:
285 i_size = sizeof(aout_instance_t);
286 psz_type = "audio output";
288 case VLC_OBJECT_SOUT:
289 i_size = sizeof(sout_instance_t);
290 psz_type = "stream output";
293 i_size = sizeof( vlm_t );
294 psz_type = "vlm dameon";
297 i_size = sizeof( vod_t );
298 psz_type = "vod server";
301 i_size = sizeof( tls_t );
305 i_size = sizeof( xml_t );
308 case VLC_OBJECT_OPENGL:
309 i_size = sizeof( vout_thread_t );
312 case VLC_OBJECT_ANNOUNCE:
313 i_size = sizeof( announce_handler_t );
314 psz_type = "announce";
316 case VLC_OBJECT_META_ENGINE:
317 i_size = sizeof( meta_engine_t );
318 psz_type = "meta engine";
320 case VLC_OBJECT_OSDMENU:
321 i_size = sizeof( osd_menu_t );
322 psz_type = "osd menu";
325 i_size = i_type > (int)sizeof(vlc_object_t)
326 ? i_type : (int)sizeof(vlc_object_t);
327 i_type = VLC_OBJECT_GENERIC;
328 psz_type = "generic";
332 return vlc_custom_create( p_this, i_size, i_type, psz_type );
337 ****************************************************************************
338 * Destroy a vlc object
340 * This function destroys an object that has been previously allocated with
341 * vlc_object_create. The object's refcount must be zero and it must not be
342 * attached to other objects in any way.
343 *****************************************************************************/
344 void __vlc_object_destroy( vlc_object_t *p_this )
346 vlc_object_internals_t *p_priv = vlc_internals( p_this );
349 if( p_this->i_children )
351 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
352 p_this->i_object_id, p_this->psz_object_name );
356 if( p_this->p_parent )
358 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
359 p_this->i_object_id, p_this->psz_object_name );
363 while( p_this->i_refcount )
367 /* Don't warn immediately ... 100ms seems OK */
371 "refcount is %i, delaying before deletion (id=%d,type=%d)",
372 p_this->i_refcount, p_this->i_object_id,
373 p_this->i_object_type );
375 else if( i_delay == 10 )
378 "refcount is %i, delaying again (id=%d,type=%d)",
379 p_this->i_refcount, p_this->i_object_id,
380 p_this->i_object_type );
382 else if( i_delay == 20 )
385 "waited too long, cancelling destruction (id=%d,type=%d)",
386 p_this->i_object_id, p_this->i_object_type );
393 /* Destroy the associated variables, starting from the end so that
394 * no memmove calls have to be done. */
395 while( p_this->i_vars )
397 var_Destroy( p_this, p_this->p_vars[p_this->i_vars - 1].psz_name );
400 free( p_this->p_vars );
401 vlc_mutex_destroy( &p_this->var_lock );
403 if( p_this->psz_header ) free( p_this->psz_header );
405 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
407 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
408 /* We are the global object ... no need to lock. */
409 free( p_global->pp_objects );
410 p_global->pp_objects = NULL;
411 p_global->i_objects--;
413 vlc_mutex_destroy( &structure_lock );
417 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
420 vlc_mutex_lock( &structure_lock );
422 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
423 * useless to try and recover anything if pp_objects gets smashed. */
424 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
425 p_libvlc_global->i_objects );
426 REMOVE_ELEM( p_libvlc_global->pp_objects,
427 p_libvlc_global->i_objects, i_index );
429 vlc_mutex_unlock( &structure_lock );
432 vlc_mutex_destroy( &p_this->object_lock );
433 vlc_cond_destroy( &p_this->object_wait );
435 /* global is not dynamically allocated by vlc_object_create */
436 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
441 void __vlc_object_kill( vlc_object_t *p_this )
443 vlc_mutex_lock( &p_this->object_lock );
444 p_this->b_die = VLC_TRUE;
445 vlc_mutex_unlock( &p_this->object_lock );
449 vlc_bool_t __vlc_object_dying_unlocked( vlc_object_t *p_this )
451 vlc_assert_locked( &p_this->object_lock );
452 return p_this->b_die;
456 vlc_bool_t __vlc_object_dying( vlc_object_t *p_this )
459 vlc_mutex_lock( &p_this->object_lock );
460 b = __vlc_object_dying_unlocked( p_this );
461 vlc_mutex_unlock( &p_this->object_lock );
467 * find an object given its ID
469 * This function looks for the object whose i_object_id field is i_id. We
470 * use a dichotomy so that lookups are in log2(n).
471 *****************************************************************************/
472 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
475 vlc_object_t **pp_objects;
476 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
478 vlc_mutex_lock( &structure_lock );
480 pp_objects = p_libvlc_global->pp_objects;
482 /* Perform our dichotomy */
483 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
485 i_middle = i_max / 2;
487 if( pp_objects[i_middle]->i_object_id > i_id )
491 else if( pp_objects[i_middle]->i_object_id < i_id )
495 pp_objects += i_middle;
500 /* This happens when there are only two remaining objects */
501 if( pp_objects[i_middle+1]->i_object_id == i_id )
503 vlc_mutex_unlock( &structure_lock );
504 pp_objects[i_middle+1]->i_refcount++;
505 return pp_objects[i_middle+1];
512 vlc_mutex_unlock( &structure_lock );
513 pp_objects[i_middle]->i_refcount++;
514 return pp_objects[i_middle];
519 /* this means that i_max == i_middle, and since we have already
520 * tested pp_objects[i_middle]), p_found is properly set. */
525 vlc_mutex_unlock( &structure_lock );
530 ****************************************************************************
531 * find a typed object and increment its refcount
532 *****************************************************************************
533 * This function recursively looks for a given object type. i_mode can be one
534 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
535 *****************************************************************************/
536 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
538 vlc_object_t *p_found;
540 vlc_mutex_lock( &structure_lock );
542 /* If we are of the requested type ourselves, don't look further */
543 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
545 p_this->i_refcount++;
546 vlc_mutex_unlock( &structure_lock );
550 /* Otherwise, recursively look for the object */
551 if( (i_mode & 0x000f) == FIND_ANYWHERE )
553 vlc_object_t *p_root = p_this;
556 while( p_root->p_parent != NULL &&
557 p_root != VLC_OBJECT( p_this->p_libvlc ) )
559 p_root = p_root->p_parent;
562 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
563 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
565 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
566 i_type, (i_mode & ~0x000f)|FIND_CHILD );
571 p_found = FindObject( p_this, i_type, i_mode );
574 vlc_mutex_unlock( &structure_lock );
580 ****************************************************************************
581 * find a named object and increment its refcount
582 *****************************************************************************
583 * This function recursively looks for a given object name. i_mode can be one
584 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
585 *****************************************************************************/
586 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
589 vlc_object_t *p_found;
591 vlc_mutex_lock( &structure_lock );
593 /* If have the requested name ourselves, don't look further */
594 if( !(i_mode & FIND_STRICT)
595 && p_this->psz_object_name
596 && !strcmp( p_this->psz_object_name, psz_name ) )
598 p_this->i_refcount++;
599 vlc_mutex_unlock( &structure_lock );
603 /* Otherwise, recursively look for the object */
604 if( (i_mode & 0x000f) == FIND_ANYWHERE )
606 vlc_object_t *p_root = p_this;
609 while( p_root->p_parent != NULL &&
610 p_root != VLC_OBJECT( p_this->p_libvlc ) )
612 p_root = p_root->p_parent;
615 p_found = FindObjectName( p_root, psz_name,
616 (i_mode & ~0x000f)|FIND_CHILD );
617 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
619 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
620 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
625 p_found = FindObjectName( p_this, psz_name, i_mode );
628 vlc_mutex_unlock( &structure_lock );
634 ****************************************************************************
635 * increment an object refcount
636 *****************************************************************************/
637 void __vlc_object_yield( vlc_object_t *p_this )
639 vlc_mutex_lock( &structure_lock );
640 p_this->i_refcount++;
641 vlc_mutex_unlock( &structure_lock );
645 ****************************************************************************
646 * decrement an object refcount
647 *****************************************************************************/
648 void __vlc_object_release( vlc_object_t *p_this )
650 vlc_mutex_lock( &structure_lock );
651 p_this->i_refcount--;
652 vlc_mutex_unlock( &structure_lock );
656 ****************************************************************************
657 * attach object to a parent object
658 *****************************************************************************
659 * This function sets p_this as a child of p_parent, and p_parent as a parent
660 * of p_this. This link can be undone using vlc_object_detach.
661 *****************************************************************************/
662 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
664 if( !p_this ) return;
666 vlc_mutex_lock( &structure_lock );
668 /* Attach the parent to its child */
669 p_this->p_parent = p_parent;
671 /* Attach the child to its parent */
672 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
673 p_parent->i_children, p_this );
675 /* Climb up the tree to see whether we are connected with the root */
676 if( p_parent->b_attached )
678 SetAttachment( p_this, VLC_TRUE );
681 vlc_mutex_unlock( &structure_lock );
685 ****************************************************************************
686 * detach object from its parent
687 *****************************************************************************
688 * This function removes all links between an object and its parent.
689 *****************************************************************************/
690 void __vlc_object_detach( vlc_object_t *p_this )
692 if( !p_this ) return;
694 vlc_mutex_lock( &structure_lock );
695 if( !p_this->p_parent )
697 msg_Err( p_this, "object is not attached" );
698 vlc_mutex_unlock( &structure_lock );
702 /* Climb up the tree to see whether we are connected with the root */
703 if( p_this->p_parent->b_attached )
705 SetAttachment( p_this, VLC_FALSE );
708 DetachObject( p_this );
709 vlc_mutex_unlock( &structure_lock );
714 ****************************************************************************
715 * find a list typed objects and increment their refcount
716 *****************************************************************************
717 * This function recursively looks for a given object type. i_mode can be one
718 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
719 *****************************************************************************/
720 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
723 vlc_object_t **pp_current, **pp_end;
724 int i_count = 0, i_index = 0;
725 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
727 vlc_mutex_lock( &structure_lock );
729 /* Look for the objects */
730 switch( i_mode & 0x000f )
733 pp_current = p_libvlc_global->pp_objects;
734 pp_end = pp_current + p_libvlc_global->i_objects;
736 for( ; pp_current < pp_end ; pp_current++ )
738 if( (*pp_current)->b_attached
739 && (*pp_current)->i_object_type == i_type )
745 p_list = NewList( i_count );
746 pp_current = p_libvlc_global->pp_objects;
748 for( ; pp_current < pp_end ; pp_current++ )
750 if( (*pp_current)->b_attached
751 && (*pp_current)->i_object_type == i_type )
753 ListReplace( p_list, *pp_current, i_index );
754 if( i_index < i_count ) i_index++;
760 i_count = CountChildren( p_this, i_type );
761 p_list = NewList( i_count );
763 /* Check allocation was successful */
764 if( p_list->i_count != i_count )
766 msg_Err( p_this, "list allocation failed!" );
772 ListChildren( p_list, p_this, i_type );
776 msg_Err( p_this, "unimplemented!" );
777 p_list = NewList( 0 );
781 vlc_mutex_unlock( &structure_lock );
786 /*****************************************************************************
787 * DumpCommand: print the current vlc structure
788 *****************************************************************************
789 * This function prints either an ASCII tree showing the connections between
790 * vlc objects, and additional information such as their refcount, thread ID,
791 * etc. (command "tree"), or the same data as a simple list (command "list").
792 *****************************************************************************/
793 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
794 vlc_value_t oldval, vlc_value_t newval, void *p_data )
796 libvlc_global_data_t *p_libvlc_global = vlc_global( p_this );
798 (void)oldval; (void)p_data;
799 if( *psz_cmd == 'l' )
801 vlc_mutex_lock( &structure_lock );
803 vlc_object_t **pp_current, **pp_end;
805 pp_current = p_libvlc_global->pp_objects;
806 pp_end = pp_current + p_libvlc_global->i_objects;
808 for( ; pp_current < pp_end ; pp_current++ )
810 if( (*pp_current)->b_attached )
812 PrintObject( *pp_current, "" );
816 printf( " o %.8i %s (not attached)\n",
817 (*pp_current)->i_object_id,
818 (*pp_current)->psz_object_type );
822 vlc_mutex_unlock( &structure_lock );
826 vlc_object_t *p_object = NULL;
828 if( *newval.psz_string )
831 int i_id = strtol( newval.psz_string, &end, 0 );
832 if( end != newval.psz_string )
833 p_object = vlc_object_get( p_this, i_id );
836 /* try using the object's name to find it */
837 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
840 /* Look in p_libvlc's children tree */
841 p_object = vlc_object_find_name( p_libvlc,
844 vlc_object_release( p_libvlc );
848 /* If it's not in libvlc, look in libvlc_global (== p_this) */
849 p_object = vlc_object_find_name( p_this,
861 vlc_mutex_lock( &structure_lock );
863 if( *psz_cmd == 't' )
865 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
868 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
871 DumpStructure( p_object, 0, psz_foo );
873 else if( *psz_cmd == 'v' )
878 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
880 PrintObject( p_object, "" );
882 if( !p_object->i_vars )
883 printf( " `-o No variables\n" );
884 for( i = 0; i < p_object->i_vars; i++ )
886 variable_t *p_var = p_object->p_vars + i;
888 const char *psz_type = "unknown";
889 switch( p_var->i_type & VLC_VAR_TYPE )
891 #define MYCASE( type, nice ) \
892 case VLC_VAR_ ## type: \
895 MYCASE( VOID, "void" );
896 MYCASE( BOOL, "bool" );
897 MYCASE( INTEGER, "integer" );
898 MYCASE( HOTKEY, "hotkey" );
899 MYCASE( STRING, "string" );
900 MYCASE( MODULE, "module" );
901 MYCASE( FILE, "file" );
902 MYCASE( DIRECTORY, "directory" );
903 MYCASE( VARIABLE, "variable" );
904 MYCASE( FLOAT, "float" );
905 MYCASE( TIME, "time" );
906 MYCASE( ADDRESS, "address" );
907 MYCASE( MUTEX, "mutex" );
908 MYCASE( LIST, "list" );
911 printf( " %c-o \"%s\" (%s",
912 i + 1 == p_object->i_vars ? '`' : '|',
913 p_var->psz_name, psz_type );
914 if( p_var->psz_text )
915 printf( ", %s", p_var->psz_text );
917 if( p_var->i_type & VLC_VAR_ISCOMMAND )
918 printf( ", command" );
919 if( p_var->i_entries )
920 printf( ", %d callbacks", p_var->i_entries );
921 switch( p_var->i_type & 0x00f0 )
927 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
929 case VLC_VAR_INTEGER:
930 printf( ": %d", p_var->val.i_int );
933 printf( ": \"%s\"", p_var->val.psz_string );
936 printf( ": %f", p_var->val.f_float );
939 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
941 case VLC_VAR_ADDRESS:
942 printf( ": %p", p_var->val.p_address );
952 vlc_mutex_unlock( &structure_lock );
954 if( *newval.psz_string )
956 vlc_object_release( p_object );
963 /*****************************************************************************
964 * vlc_list_release: free a list previously allocated by vlc_list_find
965 *****************************************************************************
966 * This function decreases the refcount of all objects in the list and
968 *****************************************************************************/
969 void vlc_list_release( vlc_list_t *p_list )
973 vlc_mutex_lock( &structure_lock );
974 for( i_index = 0; i_index < p_list->i_count; i_index++ )
976 p_list->p_values[i_index].p_object->i_refcount--;
978 vlc_mutex_unlock( &structure_lock );
980 free( p_list->p_values );
984 /* Following functions are local */
986 /*****************************************************************************
987 * FindIndex: find the index of an object in an array of objects
988 *****************************************************************************
989 * This function assumes that p_this can be found in pp_objects. It will not
990 * crash if p_this cannot be found, but will return a wrong value. It is your
991 * duty to check the return value if you are not certain that the object could
993 *****************************************************************************/
994 static int FindIndex( vlc_object_t *p_this,
995 vlc_object_t **pp_objects, int i_count )
997 int i_middle = i_count / 2;
1004 if( pp_objects[i_middle] == p_this )
1014 /* We take advantage of the sorted array */
1015 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1017 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1018 i_count - i_middle );
1022 return FindIndex( p_this, pp_objects, i_middle );
1026 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1029 vlc_object_t *p_tmp;
1031 switch( i_mode & 0x000f )
1034 p_tmp = p_this->p_parent;
1037 if( p_tmp->i_object_type == i_type )
1039 p_tmp->i_refcount++;
1044 return FindObject( p_tmp, i_type, i_mode );
1050 for( i = p_this->i_children; i--; )
1052 p_tmp = p_this->pp_children[i];
1053 if( p_tmp->i_object_type == i_type )
1055 p_tmp->i_refcount++;
1058 else if( p_tmp->i_children )
1060 p_tmp = FindObject( p_tmp, i_type, i_mode );
1070 /* Handled in vlc_object_find */
1077 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1078 const char *psz_name,
1082 vlc_object_t *p_tmp;
1084 switch( i_mode & 0x000f )
1087 p_tmp = p_this->p_parent;
1090 if( p_tmp->psz_object_name
1091 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1093 p_tmp->i_refcount++;
1098 return FindObjectName( p_tmp, psz_name, i_mode );
1104 for( i = p_this->i_children; i--; )
1106 p_tmp = p_this->pp_children[i];
1107 if( p_tmp->psz_object_name
1108 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1110 p_tmp->i_refcount++;
1113 else if( p_tmp->i_children )
1115 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1125 /* Handled in vlc_object_find */
1132 static void DetachObject( vlc_object_t *p_this )
1134 vlc_object_t *p_parent = p_this->p_parent;
1137 /* Remove p_this's parent */
1138 p_this->p_parent = NULL;
1140 /* Remove all of p_parent's children which are p_this */
1141 for( i_index = p_parent->i_children ; i_index-- ; )
1143 if( p_parent->pp_children[i_index] == p_this )
1145 p_parent->i_children--;
1146 for( i = i_index ; i < p_parent->i_children ; i++ )
1148 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1153 if( p_parent->i_children )
1155 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1156 p_parent->i_children * sizeof(vlc_object_t *) );
1160 free( p_parent->pp_children );
1161 p_parent->pp_children = NULL;
1165 /*****************************************************************************
1166 * SetAttachment: recursively set the b_attached flag of a subtree.
1167 *****************************************************************************
1168 * This function is used by the attach and detach functions to propagate
1169 * the b_attached flag in a subtree.
1170 *****************************************************************************/
1171 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1175 for( i_index = p_this->i_children ; i_index-- ; )
1177 SetAttachment( p_this->pp_children[i_index], b_attached );
1180 p_this->b_attached = b_attached;
1183 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1185 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1189 if( p_this->psz_object_name )
1191 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1193 psz_name[48] = '\"';
1196 psz_children[0] = '\0';
1197 switch( p_this->i_children )
1202 strcpy( psz_children, ", 1 child" );
1205 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1209 psz_refcount[0] = '\0';
1210 if( p_this->i_refcount )
1211 snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
1213 psz_thread[0] = '\0';
1214 if( p_this->b_thread )
1215 snprintf( psz_thread, 29, " (thread %d)", (int)p_this->thread_id );
1217 psz_parent[0] = '\0';
1218 if( p_this->p_parent )
1219 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1221 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1222 p_this->i_object_id, p_this->psz_object_type,
1223 psz_name, psz_thread, psz_refcount, psz_children,
1227 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1230 char i_back = psz_foo[i_level];
1231 psz_foo[i_level] = '\0';
1233 PrintObject( p_this, psz_foo );
1235 psz_foo[i_level] = i_back;
1237 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1239 msg_Warn( p_this, "structure tree is too deep" );
1243 for( i = 0 ; i < p_this->i_children ; i++ )
1247 psz_foo[i_level-1] = ' ';
1249 if( psz_foo[i_level-2] == '`' )
1251 psz_foo[i_level-2] = ' ';
1255 if( i == p_this->i_children - 1 )
1257 psz_foo[i_level] = '`';
1261 psz_foo[i_level] = '|';
1264 psz_foo[i_level+1] = '-';
1265 psz_foo[i_level+2] = '\0';
1267 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1271 static vlc_list_t * NewList( int i_count )
1273 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1274 if( p_list == NULL )
1279 p_list->i_count = i_count;
1283 p_list->p_values = NULL;
1287 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1288 if( p_list->p_values == NULL )
1290 p_list->i_count = 0;
1297 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1300 if( p_list == NULL || i_index >= p_list->i_count )
1305 p_object->i_refcount++;
1307 p_list->p_values[i_index].p_object = p_object;
1312 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1314 if( p_list == NULL )
1319 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1320 * sizeof( vlc_value_t ) );
1321 if( p_list->p_values == NULL )
1323 p_list->i_count = 0;
1327 p_object->i_refcount++;
1329 p_list->p_values[p_list->i_count].p_object = p_object;
1335 static int CountChildren( vlc_object_t *p_this, int i_type )
1337 vlc_object_t *p_tmp;
1340 for( i = 0; i < p_this->i_children; i++ )
1342 p_tmp = p_this->pp_children[i];
1344 if( p_tmp->i_object_type == i_type )
1349 if( p_tmp->i_children )
1351 i_count += CountChildren( p_tmp, i_type );
1358 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1360 vlc_object_t *p_tmp;
1363 for( i = 0; i < p_this->i_children; i++ )
1365 p_tmp = p_this->pp_children[i];
1367 if( p_tmp->i_object_type == i_type )
1369 ListReplace( p_list, p_tmp, p_list->i_count++ );
1372 if( p_tmp->i_children )
1374 ListChildren( p_list, p_tmp, i_type );