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"
63 /*****************************************************************************
65 *****************************************************************************/
66 static int DumpCommand( vlc_object_t *, char const *,
67 vlc_value_t, vlc_value_t, void * );
69 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
70 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
71 static void DetachObject ( vlc_object_t * );
72 static void PrintObject ( vlc_object_t *, const char * );
73 static void DumpStructure ( vlc_object_t *, int, char * );
74 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
75 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
77 static vlc_list_t * NewList ( int );
78 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
79 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
80 static int CountChildren ( vlc_object_t *, int );
81 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
83 /*****************************************************************************
84 * Local structure lock
85 *****************************************************************************/
86 static vlc_mutex_t structure_lock;
87 static vlc_object_internals_t global_internals;
89 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
90 int i_type, const char *psz_type )
93 vlc_object_internals_t *p_priv;
95 if( i_type == VLC_OBJECT_GLOBAL )
98 p_priv = &global_internals;
99 memset( p_priv, 0, sizeof( *p_priv ) );
103 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
107 p_new = (vlc_object_t *)(p_priv + 1);
110 p_new->p_internals = p_priv;
111 p_new->i_object_type = i_type;
112 p_new->psz_object_type = psz_type;
114 p_new->psz_object_name = NULL;
116 p_new->b_die = VLC_FALSE;
117 p_new->b_error = VLC_FALSE;
118 p_new->b_dead = VLC_FALSE;
119 p_priv->b_attached = VLC_FALSE;
120 p_new->b_force = VLC_FALSE;
122 p_new->psz_header = NULL;
124 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
125 p_new->i_flags |= OBJECT_FLAGS_NODBG;
126 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
127 p_new->i_flags |= OBJECT_FLAGS_QUIET;
128 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
129 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
131 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
133 if( !p_priv->p_vars )
135 if( i_type != VLC_OBJECT_GLOBAL )
140 if( i_type == VLC_OBJECT_GLOBAL )
142 /* If i_type is global, then p_new is actually p_libvlc_global */
143 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
144 p_new->p_libvlc = NULL;
146 p_libvlc_global->i_counter = 0;
147 p_new->i_object_id = 0;
149 p_libvlc_global->i_objects = 1;
150 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
151 p_libvlc_global->pp_objects[0] = p_new;
152 p_priv->b_attached = VLC_TRUE;
156 libvlc_global_data_t *p_libvlc_global = vlc_global();
157 if( i_type == VLC_OBJECT_LIBVLC )
159 p_new->p_libvlc = (libvlc_int_t*)p_new;
160 p_priv->b_attached = VLC_TRUE;
164 p_new->p_libvlc = p_this->p_libvlc;
167 vlc_mutex_lock( &structure_lock );
169 p_libvlc_global->i_counter++;
170 p_new->i_object_id = p_libvlc_global->i_counter;
172 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
173 * useless to try and recover anything if pp_objects gets smashed. */
174 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
177 vlc_mutex_unlock( &structure_lock );
180 p_new->i_refcount = 0;
181 p_new->p_parent = NULL;
182 p_new->pp_children = NULL;
183 p_new->i_children = 0;
185 p_new->p_private = NULL;
187 /* Initialize mutexes and condvars */
188 vlc_mutex_init( p_new, &p_new->object_lock );
189 vlc_cond_init( p_new, &p_new->object_wait );
190 vlc_mutex_init( p_new, &p_priv->var_lock );
192 if( i_type == VLC_OBJECT_GLOBAL )
194 vlc_mutex_init( p_new, &structure_lock );
197 if( i_type == VLC_OBJECT_LIBVLC )
199 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
200 var_AddCallback( p_new, "list", DumpCommand, NULL );
201 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
202 var_AddCallback( p_new, "tree", DumpCommand, NULL );
203 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
204 var_AddCallback( p_new, "vars", DumpCommand, NULL );
212 * Allocates and initializes a vlc object.
214 * @param i_type known object type (all of them are negative integer values),
215 * or object byte size (always positive).
217 * @return the new object, or NULL on error.
219 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
221 const char * psz_type;
226 case VLC_OBJECT_GLOBAL:
227 i_size = sizeof(libvlc_global_data_t);
230 case VLC_OBJECT_LIBVLC:
231 i_size = sizeof(libvlc_int_t);
234 case VLC_OBJECT_INTF:
235 i_size = sizeof(intf_thread_t);
236 psz_type = "interface";
238 case VLC_OBJECT_DIALOGS:
239 i_size = sizeof(intf_thread_t);
240 psz_type = "dialogs";
242 case VLC_OBJECT_PLAYLIST:
243 i_size = sizeof(playlist_t);
244 psz_type = "playlist";
247 i_size = sizeof(services_discovery_t);
248 psz_type = "services discovery";
250 case VLC_OBJECT_INPUT:
251 i_size = sizeof(input_thread_t);
254 case VLC_OBJECT_DEMUX:
255 i_size = sizeof(demux_t);
258 case VLC_OBJECT_ACCESS:
259 i_size = sizeof(access_t);
262 case VLC_OBJECT_DECODER:
263 i_size = sizeof(decoder_t);
264 psz_type = "decoder";
266 case VLC_OBJECT_PACKETIZER:
267 i_size = sizeof(decoder_t);
268 psz_type = "packetizer";
270 case VLC_OBJECT_ENCODER:
271 i_size = sizeof(encoder_t);
272 psz_type = "encoder";
274 case VLC_OBJECT_FILTER:
275 i_size = sizeof(filter_t);
278 case VLC_OBJECT_VOUT:
279 i_size = sizeof(vout_thread_t);
280 psz_type = "video output";
283 i_size = sizeof(spu_t);
284 psz_type = "subpicture";
286 case VLC_OBJECT_AOUT:
287 i_size = sizeof(aout_instance_t);
288 psz_type = "audio output";
290 case VLC_OBJECT_SOUT:
291 i_size = sizeof(sout_instance_t);
292 psz_type = "stream output";
295 i_size = sizeof( vlm_t );
296 psz_type = "vlm dameon";
299 i_size = sizeof( vod_t );
300 psz_type = "vod server";
303 i_size = sizeof( xml_t );
306 case VLC_OBJECT_OPENGL:
307 i_size = sizeof( vout_thread_t );
310 case VLC_OBJECT_ANNOUNCE:
311 i_size = sizeof( announce_handler_t );
312 psz_type = "announce";
314 case VLC_OBJECT_META_ENGINE:
315 i_size = sizeof( meta_engine_t );
316 psz_type = "meta engine";
318 case VLC_OBJECT_OSDMENU:
319 i_size = sizeof( osd_menu_t );
320 psz_type = "osd menu";
323 i_size = i_type > (int)sizeof(vlc_object_t)
324 ? i_type : (int)sizeof(vlc_object_t);
325 i_type = VLC_OBJECT_GENERIC;
326 psz_type = "generic";
330 return vlc_custom_create( p_this, i_size, i_type, psz_type );
335 ****************************************************************************
336 * Destroy a vlc object
338 * This function destroys an object that has been previously allocated with
339 * vlc_object_create. The object's refcount must be zero and it must not be
340 * attached to other objects in any way.
341 *****************************************************************************/
342 void __vlc_object_destroy( vlc_object_t *p_this )
344 vlc_object_internals_t *p_priv = vlc_internals( p_this );
347 if( p_this->i_children )
349 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
350 p_this->i_object_id, p_this->psz_object_name );
354 if( p_this->p_parent )
356 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
357 p_this->i_object_id, p_this->psz_object_name );
361 while( p_this->i_refcount )
365 /* Don't warn immediately ... 100ms seems OK */
369 "refcount is %i, delaying before deletion (id=%d,type=%d)",
370 p_this->i_refcount, p_this->i_object_id,
371 p_this->i_object_type );
373 else if( i_delay == 10 )
376 "refcount is %i, delaying again (id=%d,type=%d)",
377 p_this->i_refcount, p_this->i_object_id,
378 p_this->i_object_type );
380 else if( i_delay == 20 )
383 "waited too long, cancelling destruction (id=%d,type=%d)",
384 p_this->i_object_id, p_this->i_object_type );
391 /* Destroy the associated variables, starting from the end so that
392 * no memmove calls have to be done. */
393 while( p_priv->i_vars )
395 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
398 free( p_priv->p_vars );
399 vlc_mutex_destroy( &p_priv->var_lock );
401 if( p_this->psz_header ) free( p_this->psz_header );
403 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
405 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
406 /* We are the global object ... no need to lock. */
407 free( p_global->pp_objects );
408 p_global->pp_objects = NULL;
409 p_global->i_objects--;
411 vlc_mutex_destroy( &structure_lock );
415 libvlc_global_data_t *p_libvlc_global = vlc_global();
418 vlc_mutex_lock( &structure_lock );
420 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
421 * useless to try and recover anything if pp_objects gets smashed. */
422 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
423 p_libvlc_global->i_objects );
424 REMOVE_ELEM( p_libvlc_global->pp_objects,
425 p_libvlc_global->i_objects, i_index );
427 vlc_mutex_unlock( &structure_lock );
430 #if defined(WIN32) || defined(UNDER_CE)
431 /* if object has an associated thread, close it now */
432 if( p_priv->thread_id.hThread )
433 CloseHandle(p_priv->thread_id.hThread);
436 vlc_mutex_destroy( &p_this->object_lock );
437 vlc_cond_destroy( &p_this->object_wait );
439 /* global is not dynamically allocated by vlc_object_create */
440 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
445 /** Inter-object signaling */
447 void __vlc_object_lock( vlc_object_t *obj )
449 vlc_mutex_lock( &obj->object_lock );
452 void __vlc_object_unlock( vlc_object_t *obj )
454 vlc_assert_locked( &obj->object_lock );
455 vlc_mutex_unlock( &obj->object_lock );
459 * Waits for the object to be signaled (using vlc_object_signal()).
460 * If the object already has a signal pending, this function will return
461 * immediately. It is asserted that the caller holds the object lock.
463 * @return true if the object is dying and should terminate.
465 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
467 vlc_assert_locked( &obj->object_lock );
468 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
474 * Waits for the object to be signaled (using vlc_object_signal()), or for
476 * If the object already has a signal pending, this function will return
477 * immediately. It is asserted that the caller holds the object lock.
479 * @return negative if the object is dying and should terminate,
480 * positive if the the object has been signaled but is not dying,
481 * 0 if timeout has been reached.
483 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
487 vlc_assert_locked( &obj->object_lock );
488 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
489 if( v == 0 ) /* signaled */
490 return obj->b_die ? -1 : 1;
496 * Signals an object for which the lock is held.
498 void __vlc_object_signal_unlocked( vlc_object_t *obj )
500 vlc_assert_locked( &obj->object_lock );
501 vlc_cond_signal( &obj->object_wait );
506 * Requests termination of an object.
507 * If the object is LibVLC, also request to terminate all its children.
509 void __vlc_object_kill( vlc_object_t *p_this )
511 vlc_mutex_lock( &p_this->object_lock );
513 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
514 for( int i = 0; i < p_this->i_children ; i++ )
515 vlc_object_kill( p_this->pp_children[i] );
517 p_this->b_die = VLC_TRUE;
518 vlc_object_signal_unlocked( p_this );
519 vlc_mutex_unlock( &p_this->object_lock );
524 * find an object given its ID
526 * This function looks for the object whose i_object_id field is i_id. We
527 * use a dichotomy so that lookups are in log2(n).
528 *****************************************************************************/
529 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
532 vlc_object_t **pp_objects;
533 libvlc_global_data_t *p_libvlc_global = vlc_global();
535 vlc_mutex_lock( &structure_lock );
537 pp_objects = p_libvlc_global->pp_objects;
539 /* Perform our dichotomy */
540 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
542 i_middle = i_max / 2;
544 if( pp_objects[i_middle]->i_object_id > i_id )
548 else if( pp_objects[i_middle]->i_object_id < i_id )
552 pp_objects += i_middle;
557 /* This happens when there are only two remaining objects */
558 if( pp_objects[i_middle+1]->i_object_id == i_id )
560 vlc_mutex_unlock( &structure_lock );
561 pp_objects[i_middle+1]->i_refcount++;
562 return pp_objects[i_middle+1];
569 vlc_mutex_unlock( &structure_lock );
570 pp_objects[i_middle]->i_refcount++;
571 return pp_objects[i_middle];
576 /* this means that i_max == i_middle, and since we have already
577 * tested pp_objects[i_middle]), p_found is properly set. */
582 vlc_mutex_unlock( &structure_lock );
587 ****************************************************************************
588 * find a typed object and increment its refcount
589 *****************************************************************************
590 * This function recursively looks for a given object type. i_mode can be one
591 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
592 *****************************************************************************/
593 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
595 vlc_object_t *p_found;
597 vlc_mutex_lock( &structure_lock );
599 /* If we are of the requested type ourselves, don't look further */
600 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
602 p_this->i_refcount++;
603 vlc_mutex_unlock( &structure_lock );
607 /* Otherwise, recursively look for the object */
608 if( (i_mode & 0x000f) == FIND_ANYWHERE )
610 vlc_object_t *p_root = p_this;
613 while( p_root->p_parent != NULL &&
614 p_root != VLC_OBJECT( p_this->p_libvlc ) )
616 p_root = p_root->p_parent;
619 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
620 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
622 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
623 i_type, (i_mode & ~0x000f)|FIND_CHILD );
628 p_found = FindObject( p_this, i_type, i_mode );
631 vlc_mutex_unlock( &structure_lock );
637 ****************************************************************************
638 * find a named object and increment its refcount
639 *****************************************************************************
640 * This function recursively looks for a given object name. i_mode can be one
641 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
642 *****************************************************************************/
643 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
646 vlc_object_t *p_found;
648 vlc_mutex_lock( &structure_lock );
650 /* If have the requested name ourselves, don't look further */
651 if( !(i_mode & FIND_STRICT)
652 && p_this->psz_object_name
653 && !strcmp( p_this->psz_object_name, psz_name ) )
655 p_this->i_refcount++;
656 vlc_mutex_unlock( &structure_lock );
660 /* Otherwise, recursively look for the object */
661 if( (i_mode & 0x000f) == FIND_ANYWHERE )
663 vlc_object_t *p_root = p_this;
666 while( p_root->p_parent != NULL &&
667 p_root != VLC_OBJECT( p_this->p_libvlc ) )
669 p_root = p_root->p_parent;
672 p_found = FindObjectName( p_root, psz_name,
673 (i_mode & ~0x000f)|FIND_CHILD );
674 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
676 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
677 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
682 p_found = FindObjectName( p_this, psz_name, i_mode );
685 vlc_mutex_unlock( &structure_lock );
691 ****************************************************************************
692 * increment an object refcount
693 *****************************************************************************/
694 void __vlc_object_yield( vlc_object_t *p_this )
696 vlc_mutex_lock( &structure_lock );
697 p_this->i_refcount++;
698 vlc_mutex_unlock( &structure_lock );
702 ****************************************************************************
703 * decrement an object refcount
704 *****************************************************************************/
705 void __vlc_object_release( vlc_object_t *p_this )
707 vlc_mutex_lock( &structure_lock );
708 p_this->i_refcount--;
709 vlc_mutex_unlock( &structure_lock );
713 ****************************************************************************
714 * attach object to a parent object
715 *****************************************************************************
716 * This function sets p_this as a child of p_parent, and p_parent as a parent
717 * of p_this. This link can be undone using vlc_object_detach.
718 *****************************************************************************/
719 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
721 if( !p_this ) return;
723 vlc_mutex_lock( &structure_lock );
725 /* Attach the parent to its child */
726 p_this->p_parent = p_parent;
728 /* Attach the child to its parent */
729 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
730 p_parent->i_children, p_this );
732 /* Climb up the tree to see whether we are connected with the root */
733 if( p_parent->p_internals->b_attached )
735 SetAttachment( p_this, VLC_TRUE );
738 vlc_mutex_unlock( &structure_lock );
742 ****************************************************************************
743 * detach object from its parent
744 *****************************************************************************
745 * This function removes all links between an object and its parent.
746 *****************************************************************************/
747 void __vlc_object_detach( vlc_object_t *p_this )
749 if( !p_this ) return;
751 vlc_mutex_lock( &structure_lock );
752 if( !p_this->p_parent )
754 msg_Err( p_this, "object is not attached" );
755 vlc_mutex_unlock( &structure_lock );
759 /* Climb up the tree to see whether we are connected with the root */
760 if( p_this->p_parent->p_internals->b_attached )
762 SetAttachment( p_this, VLC_FALSE );
765 DetachObject( p_this );
766 vlc_mutex_unlock( &structure_lock );
771 ****************************************************************************
772 * find a list typed objects and increment their refcount
773 *****************************************************************************
774 * This function recursively looks for a given object type. i_mode can be one
775 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
776 *****************************************************************************/
777 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
780 vlc_object_t **pp_current, **pp_end;
781 int i_count = 0, i_index = 0;
782 libvlc_global_data_t *p_libvlc_global = vlc_global();
784 vlc_mutex_lock( &structure_lock );
786 /* Look for the objects */
787 switch( i_mode & 0x000f )
790 pp_current = p_libvlc_global->pp_objects;
791 pp_end = pp_current + p_libvlc_global->i_objects;
793 for( ; pp_current < pp_end ; pp_current++ )
795 if( (*pp_current)->p_internals->b_attached
796 && (*pp_current)->i_object_type == i_type )
802 p_list = NewList( i_count );
803 pp_current = p_libvlc_global->pp_objects;
805 for( ; pp_current < pp_end ; pp_current++ )
807 if( (*pp_current)->p_internals->b_attached
808 && (*pp_current)->i_object_type == i_type )
810 ListReplace( p_list, *pp_current, i_index );
811 if( i_index < i_count ) i_index++;
817 i_count = CountChildren( p_this, i_type );
818 p_list = NewList( i_count );
820 /* Check allocation was successful */
821 if( p_list->i_count != i_count )
823 msg_Err( p_this, "list allocation failed!" );
829 ListChildren( p_list, p_this, i_type );
833 msg_Err( p_this, "unimplemented!" );
834 p_list = NewList( 0 );
838 vlc_mutex_unlock( &structure_lock );
843 /*****************************************************************************
844 * DumpCommand: print the current vlc structure
845 *****************************************************************************
846 * This function prints either an ASCII tree showing the connections between
847 * vlc objects, and additional information such as their refcount, thread ID,
848 * etc. (command "tree"), or the same data as a simple list (command "list").
849 *****************************************************************************/
850 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
851 vlc_value_t oldval, vlc_value_t newval, void *p_data )
853 libvlc_global_data_t *p_libvlc_global = vlc_global();
855 (void)oldval; (void)p_data;
856 if( *psz_cmd == 'l' )
858 vlc_mutex_lock( &structure_lock );
860 vlc_object_t **pp_current, **pp_end;
862 pp_current = p_libvlc_global->pp_objects;
863 pp_end = pp_current + p_libvlc_global->i_objects;
865 for( ; pp_current < pp_end ; pp_current++ )
867 if( (*pp_current)->p_internals->b_attached )
869 PrintObject( *pp_current, "" );
873 printf( " o %.8i %s (not attached)\n",
874 (*pp_current)->i_object_id,
875 (*pp_current)->psz_object_type );
879 vlc_mutex_unlock( &structure_lock );
883 vlc_object_t *p_object = NULL;
885 if( *newval.psz_string )
888 int i_id = strtol( newval.psz_string, &end, 0 );
889 if( end != newval.psz_string )
890 p_object = vlc_object_get( p_this, i_id );
893 /* try using the object's name to find it */
894 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
897 /* Look in p_libvlc's children tree */
898 p_object = vlc_object_find_name( p_libvlc,
901 vlc_object_release( p_libvlc );
905 /* If it's not in libvlc, look in libvlc_global (== p_this) */
906 p_object = vlc_object_find_name( p_this,
918 vlc_mutex_lock( &structure_lock );
920 if( *psz_cmd == 't' )
922 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
925 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
928 DumpStructure( p_object, 0, psz_foo );
930 else if( *psz_cmd == 'v' )
935 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
937 PrintObject( p_object, "" );
939 if( !p_object->p_internals->i_vars )
940 printf( " `-o No variables\n" );
941 for( i = 0; i < p_object->p_internals->i_vars; i++ )
943 variable_t *p_var = p_object->p_internals->p_vars + i;
945 const char *psz_type = "unknown";
946 switch( p_var->i_type & VLC_VAR_TYPE )
948 #define MYCASE( type, nice ) \
949 case VLC_VAR_ ## type: \
952 MYCASE( VOID, "void" );
953 MYCASE( BOOL, "bool" );
954 MYCASE( INTEGER, "integer" );
955 MYCASE( HOTKEY, "hotkey" );
956 MYCASE( STRING, "string" );
957 MYCASE( MODULE, "module" );
958 MYCASE( FILE, "file" );
959 MYCASE( DIRECTORY, "directory" );
960 MYCASE( VARIABLE, "variable" );
961 MYCASE( FLOAT, "float" );
962 MYCASE( TIME, "time" );
963 MYCASE( ADDRESS, "address" );
964 MYCASE( MUTEX, "mutex" );
965 MYCASE( LIST, "list" );
968 printf( " %c-o \"%s\" (%s",
969 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
970 p_var->psz_name, psz_type );
971 if( p_var->psz_text )
972 printf( ", %s", p_var->psz_text );
974 if( p_var->i_type & VLC_VAR_ISCOMMAND )
975 printf( ", command" );
976 if( p_var->i_entries )
977 printf( ", %d callbacks", p_var->i_entries );
978 switch( p_var->i_type & 0x00f0 )
984 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
986 case VLC_VAR_INTEGER:
987 printf( ": %d", p_var->val.i_int );
990 printf( ": \"%s\"", p_var->val.psz_string );
993 printf( ": %f", p_var->val.f_float );
996 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
998 case VLC_VAR_ADDRESS:
999 printf( ": %p", p_var->val.p_address );
1009 vlc_mutex_unlock( &structure_lock );
1011 if( *newval.psz_string )
1013 vlc_object_release( p_object );
1020 /*****************************************************************************
1021 * vlc_list_release: free a list previously allocated by vlc_list_find
1022 *****************************************************************************
1023 * This function decreases the refcount of all objects in the list and
1025 *****************************************************************************/
1026 void vlc_list_release( vlc_list_t *p_list )
1030 vlc_mutex_lock( &structure_lock );
1031 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1033 p_list->p_values[i_index].p_object->i_refcount--;
1035 vlc_mutex_unlock( &structure_lock );
1037 free( p_list->p_values );
1041 /* Following functions are local */
1043 /*****************************************************************************
1044 * FindIndex: find the index of an object in an array of objects
1045 *****************************************************************************
1046 * This function assumes that p_this can be found in pp_objects. It will not
1047 * crash if p_this cannot be found, but will return a wrong value. It is your
1048 * duty to check the return value if you are not certain that the object could
1049 * be found for sure.
1050 *****************************************************************************/
1051 static int FindIndex( vlc_object_t *p_this,
1052 vlc_object_t **pp_objects, int i_count )
1054 int i_middle = i_count / 2;
1061 if( pp_objects[i_middle] == p_this )
1071 /* We take advantage of the sorted array */
1072 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1074 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1075 i_count - i_middle );
1079 return FindIndex( p_this, pp_objects, i_middle );
1083 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1086 vlc_object_t *p_tmp;
1088 switch( i_mode & 0x000f )
1091 p_tmp = p_this->p_parent;
1094 if( p_tmp->i_object_type == i_type )
1096 p_tmp->i_refcount++;
1101 return FindObject( p_tmp, i_type, i_mode );
1107 for( i = p_this->i_children; i--; )
1109 p_tmp = p_this->pp_children[i];
1110 if( p_tmp->i_object_type == i_type )
1112 p_tmp->i_refcount++;
1115 else if( p_tmp->i_children )
1117 p_tmp = FindObject( p_tmp, i_type, i_mode );
1127 /* Handled in vlc_object_find */
1134 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1135 const char *psz_name,
1139 vlc_object_t *p_tmp;
1141 switch( i_mode & 0x000f )
1144 p_tmp = p_this->p_parent;
1147 if( p_tmp->psz_object_name
1148 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1150 p_tmp->i_refcount++;
1155 return FindObjectName( p_tmp, psz_name, i_mode );
1161 for( i = p_this->i_children; i--; )
1163 p_tmp = p_this->pp_children[i];
1164 if( p_tmp->psz_object_name
1165 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1167 p_tmp->i_refcount++;
1170 else if( p_tmp->i_children )
1172 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1182 /* Handled in vlc_object_find */
1189 static void DetachObject( vlc_object_t *p_this )
1191 vlc_object_t *p_parent = p_this->p_parent;
1194 /* Remove p_this's parent */
1195 p_this->p_parent = NULL;
1197 /* Remove all of p_parent's children which are p_this */
1198 for( i_index = p_parent->i_children ; i_index-- ; )
1200 if( p_parent->pp_children[i_index] == p_this )
1202 p_parent->i_children--;
1203 for( i = i_index ; i < p_parent->i_children ; i++ )
1205 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1210 if( p_parent->i_children )
1212 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1213 p_parent->i_children * sizeof(vlc_object_t *) );
1217 free( p_parent->pp_children );
1218 p_parent->pp_children = NULL;
1222 /*****************************************************************************
1223 * SetAttachment: recursively set the b_attached flag of a subtree.
1224 *****************************************************************************
1225 * This function is used by the attach and detach functions to propagate
1226 * the b_attached flag in a subtree.
1227 *****************************************************************************/
1228 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1232 for( i_index = p_this->i_children ; i_index-- ; )
1234 SetAttachment( p_this->pp_children[i_index], b_attached );
1237 p_this->p_internals->b_attached = b_attached;
1240 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1242 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1246 if( p_this->psz_object_name )
1248 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1250 psz_name[48] = '\"';
1253 psz_children[0] = '\0';
1254 switch( p_this->i_children )
1259 strcpy( psz_children, ", 1 child" );
1262 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1266 psz_refcount[0] = '\0';
1267 if( p_this->i_refcount )
1268 snprintf( psz_refcount, 19, ", refcount %i", p_this->i_refcount );
1270 psz_thread[0] = '\0';
1271 if( p_this->p_internals->b_thread )
1272 snprintf( psz_thread, 29, " (thread %u)",
1273 #if defined(WIN32) || defined(UNDER_CE)
1274 (unsigned)p_this->p_internals->thread_id.id );
1276 (unsigned)p_this->p_internals->thread_id );
1279 psz_parent[0] = '\0';
1280 if( p_this->p_parent )
1281 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1283 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1284 p_this->i_object_id, p_this->psz_object_type,
1285 psz_name, psz_thread, psz_refcount, psz_children,
1289 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1292 char i_back = psz_foo[i_level];
1293 psz_foo[i_level] = '\0';
1295 PrintObject( p_this, psz_foo );
1297 psz_foo[i_level] = i_back;
1299 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1301 msg_Warn( p_this, "structure tree is too deep" );
1305 for( i = 0 ; i < p_this->i_children ; i++ )
1309 psz_foo[i_level-1] = ' ';
1311 if( psz_foo[i_level-2] == '`' )
1313 psz_foo[i_level-2] = ' ';
1317 if( i == p_this->i_children - 1 )
1319 psz_foo[i_level] = '`';
1323 psz_foo[i_level] = '|';
1326 psz_foo[i_level+1] = '-';
1327 psz_foo[i_level+2] = '\0';
1329 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1333 static vlc_list_t * NewList( int i_count )
1335 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1336 if( p_list == NULL )
1341 p_list->i_count = i_count;
1345 p_list->p_values = NULL;
1349 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1350 if( p_list->p_values == NULL )
1352 p_list->i_count = 0;
1359 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1362 if( p_list == NULL || i_index >= p_list->i_count )
1367 p_object->i_refcount++;
1369 p_list->p_values[i_index].p_object = p_object;
1374 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1376 if( p_list == NULL )
1381 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1382 * sizeof( vlc_value_t ) );
1383 if( p_list->p_values == NULL )
1385 p_list->i_count = 0;
1389 p_object->i_refcount++;
1391 p_list->p_values[p_list->i_count].p_object = p_object;
1397 static int CountChildren( vlc_object_t *p_this, int i_type )
1399 vlc_object_t *p_tmp;
1402 for( i = 0; i < p_this->i_children; i++ )
1404 p_tmp = p_this->pp_children[i];
1406 if( p_tmp->i_object_type == i_type )
1411 if( p_tmp->i_children )
1413 i_count += CountChildren( p_tmp, i_type );
1420 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1422 vlc_object_t *p_tmp;
1425 for( i = 0; i < p_this->i_children; i++ )
1427 p_tmp = p_this->pp_children[i];
1429 if( p_tmp->i_object_type == i_type )
1431 ListReplace( p_list, p_tmp, p_list->i_count++ );
1434 if( p_tmp->i_children )
1436 ListChildren( p_list, p_tmp, i_type );