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"
67 # include <errno.h> /* ENOSYS */
70 /*****************************************************************************
72 *****************************************************************************/
73 static int DumpCommand( vlc_object_t *, char const *,
74 vlc_value_t, vlc_value_t, void * );
76 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
77 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
78 static void DetachObject ( vlc_object_t * );
79 static void PrintObject ( vlc_object_t *, const char * );
80 static void DumpStructure ( vlc_object_t *, int, char * );
81 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
82 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
84 static vlc_list_t * NewList ( int );
85 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
86 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
87 static int CountChildren ( vlc_object_t *, int );
88 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
90 /*****************************************************************************
91 * Local structure lock
92 *****************************************************************************/
93 static vlc_mutex_t structure_lock;
94 static vlc_object_internals_t global_internals;
96 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
97 int i_type, const char *psz_type )
100 vlc_object_internals_t *p_priv;
102 if( i_type == VLC_OBJECT_GLOBAL )
105 p_priv = &global_internals;
106 memset( p_priv, 0, sizeof( *p_priv ) );
110 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
114 p_new = (vlc_object_t *)(p_priv + 1);
117 p_new->p_internals = p_priv;
118 p_new->i_object_type = i_type;
119 p_new->psz_object_type = psz_type;
121 p_new->psz_object_name = NULL;
123 p_new->b_die = VLC_FALSE;
124 p_new->b_error = VLC_FALSE;
125 p_new->b_dead = VLC_FALSE;
126 p_priv->b_attached = VLC_FALSE;
127 p_new->b_force = VLC_FALSE;
129 p_new->psz_header = NULL;
131 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
132 p_new->i_flags |= OBJECT_FLAGS_NODBG;
133 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
134 p_new->i_flags |= OBJECT_FLAGS_QUIET;
135 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
136 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
138 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
140 if( !p_priv->p_vars )
142 if( i_type != VLC_OBJECT_GLOBAL )
147 if( i_type == VLC_OBJECT_GLOBAL )
149 /* If i_type is global, then p_new is actually p_libvlc_global */
150 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)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_priv->b_attached = VLC_TRUE;
163 libvlc_global_data_t *p_libvlc_global = vlc_global();
164 if( i_type == VLC_OBJECT_LIBVLC )
166 p_new->p_libvlc = (libvlc_int_t*)p_new;
167 p_priv->b_attached = VLC_TRUE;
171 p_new->p_libvlc = p_this->p_libvlc;
174 vlc_mutex_lock( &structure_lock );
176 p_libvlc_global->i_counter++;
177 p_new->i_object_id = p_libvlc_global->i_counter;
179 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
180 * useless to try and recover anything if pp_objects gets smashed. */
181 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
184 vlc_mutex_unlock( &structure_lock );
187 p_priv->i_refcount = 0;
188 p_new->p_parent = NULL;
189 p_new->pp_children = NULL;
190 p_new->i_children = 0;
192 p_new->p_private = NULL;
194 /* Initialize mutexes and condvars */
195 vlc_mutex_init( p_new, &p_new->object_lock );
196 vlc_cond_init( p_new, &p_new->object_wait );
197 vlc_mutex_init( p_new, &p_priv->var_lock );
198 p_priv->pipes[0] = p_priv->pipes[1] = -1;
200 if( i_type == VLC_OBJECT_GLOBAL )
202 vlc_mutex_init( p_new, &structure_lock );
205 if( i_type == VLC_OBJECT_LIBVLC )
207 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
208 var_AddCallback( p_new, "list", DumpCommand, NULL );
209 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
210 var_AddCallback( p_new, "tree", DumpCommand, NULL );
211 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
212 var_AddCallback( p_new, "vars", DumpCommand, NULL );
220 * Allocates and initializes a vlc object.
222 * @param i_type known object type (all of them are negative integer values),
223 * or object byte size (always positive).
225 * @return the new object, or NULL on error.
227 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
229 const char * psz_type;
234 case VLC_OBJECT_GLOBAL:
235 i_size = sizeof(libvlc_global_data_t);
238 case VLC_OBJECT_LIBVLC:
239 i_size = sizeof(libvlc_int_t);
242 case VLC_OBJECT_INTF:
243 i_size = sizeof(intf_thread_t);
244 psz_type = "interface";
246 case VLC_OBJECT_DIALOGS:
247 i_size = sizeof(intf_thread_t);
248 psz_type = "dialogs";
250 case VLC_OBJECT_PLAYLIST:
251 i_size = sizeof(playlist_t);
252 psz_type = "playlist";
255 i_size = sizeof(services_discovery_t);
256 psz_type = "services discovery";
258 case VLC_OBJECT_INPUT:
259 i_size = sizeof(input_thread_t);
262 case VLC_OBJECT_DEMUX:
263 i_size = sizeof(demux_t);
266 case VLC_OBJECT_ACCESS:
267 i_size = sizeof(access_t);
270 case VLC_OBJECT_DECODER:
271 i_size = sizeof(decoder_t);
272 psz_type = "decoder";
274 case VLC_OBJECT_PACKETIZER:
275 i_size = sizeof(decoder_t);
276 psz_type = "packetizer";
278 case VLC_OBJECT_ENCODER:
279 i_size = sizeof(encoder_t);
280 psz_type = "encoder";
282 case VLC_OBJECT_FILTER:
283 i_size = sizeof(filter_t);
286 case VLC_OBJECT_VOUT:
287 i_size = sizeof(vout_thread_t);
288 psz_type = "video output";
291 i_size = sizeof(spu_t);
292 psz_type = "subpicture";
294 case VLC_OBJECT_AOUT:
295 i_size = sizeof(aout_instance_t);
296 psz_type = "audio output";
298 case VLC_OBJECT_SOUT:
299 i_size = sizeof(sout_instance_t);
300 psz_type = "stream output";
303 i_size = sizeof( vlm_t );
304 psz_type = "vlm dameon";
307 i_size = sizeof( vod_t );
308 psz_type = "vod server";
311 i_size = sizeof( xml_t );
314 case VLC_OBJECT_OPENGL:
315 i_size = sizeof( vout_thread_t );
318 case VLC_OBJECT_ANNOUNCE:
319 i_size = sizeof( announce_handler_t );
320 psz_type = "announce";
322 case VLC_OBJECT_META_ENGINE:
323 i_size = sizeof( meta_engine_t );
324 psz_type = "meta engine";
326 case VLC_OBJECT_OSDMENU:
327 i_size = sizeof( osd_menu_t );
328 psz_type = "osd menu";
331 i_size = i_type > (int)sizeof(vlc_object_t)
332 ? i_type : (int)sizeof(vlc_object_t);
333 i_type = VLC_OBJECT_GENERIC;
334 psz_type = "generic";
338 return vlc_custom_create( p_this, i_size, i_type, psz_type );
343 ****************************************************************************
344 * Destroy a vlc object
346 * This function destroys an object that has been previously allocated with
347 * vlc_object_create. The object's refcount must be zero and it must not be
348 * attached to other objects in any way.
349 *****************************************************************************/
350 void __vlc_object_destroy( vlc_object_t *p_this )
352 vlc_object_internals_t *p_priv = vlc_internals( p_this );
355 if( p_this->i_children )
357 msg_Err( p_this, "cannot delete object (%i, %s) with children" ,
358 p_this->i_object_id, p_this->psz_object_name );
362 if( p_this->p_parent )
364 msg_Err( p_this, "cannot delete object (%i, %s) with a parent",
365 p_this->i_object_id, p_this->psz_object_name );
369 while( p_priv->i_refcount > 0 )
373 /* Don't warn immediately ... 100ms seems OK */
377 "refcount is %u, delaying before deletion (id=%d,type=%d)",
378 p_priv->i_refcount, p_this->i_object_id,
379 p_this->i_object_type );
381 else if( i_delay == 10 )
384 "refcount is %u, delaying again (id=%d,type=%d)",
385 p_priv->i_refcount, p_this->i_object_id,
386 p_this->i_object_type );
388 else if( i_delay == 20 )
391 "waited too long, cancelling destruction (id=%d,type=%d)",
392 p_this->i_object_id, p_this->i_object_type );
399 /* Destroy the associated variables, starting from the end so that
400 * no memmove calls have to be done. */
401 while( p_priv->i_vars )
403 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
406 free( p_priv->p_vars );
407 vlc_mutex_destroy( &p_priv->var_lock );
409 if( p_this->psz_header ) free( p_this->psz_header );
411 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
413 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
414 /* We are the global object ... no need to lock. */
415 free( p_global->pp_objects );
416 p_global->pp_objects = NULL;
417 p_global->i_objects--;
419 vlc_mutex_destroy( &structure_lock );
423 libvlc_global_data_t *p_libvlc_global = vlc_global();
426 vlc_mutex_lock( &structure_lock );
428 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
429 * useless to try and recover anything if pp_objects gets smashed. */
430 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
431 p_libvlc_global->i_objects );
432 REMOVE_ELEM( p_libvlc_global->pp_objects,
433 p_libvlc_global->i_objects, i_index );
435 vlc_mutex_unlock( &structure_lock );
438 #if defined(WIN32) || defined(UNDER_CE)
439 /* if object has an associated thread, close it now */
440 if( p_priv->thread_id.hThread )
441 CloseHandle(p_priv->thread_id.hThread);
444 vlc_mutex_destroy( &p_this->object_lock );
445 vlc_cond_destroy( &p_this->object_wait );
446 if( p_priv->pipes[0] != -1 )
447 close( p_priv->pipes[0] );
448 if( p_priv->pipes[1] != -1 )
449 close( p_priv->pipes[1] );
451 /* global is not dynamically allocated by vlc_object_create */
452 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
457 /** Inter-object signaling */
459 void __vlc_object_lock( vlc_object_t *obj )
461 vlc_mutex_lock( &obj->object_lock );
464 void __vlc_object_unlock( vlc_object_t *obj )
466 vlc_assert_locked( &obj->object_lock );
467 vlc_mutex_unlock( &obj->object_lock );
471 * Returns the readable end of a pipe that becomes readable whenever
472 * an object is signaled. This can be used to wait for VLC object events
473 * inside select(), poll() loops or frameworks providing an event loop.
475 * Note that the pipe will remain the same for the lifetime of the object.
476 * DO NOT close it yourself. Ever.
478 * DO NOT try to read from the pipe either: call vlc_object_wait() instead.
479 * Assuming the pipe is readable, vlc_object_wait() will not block.
480 * Also note that, as with vlc_object_wait(), there may be spurious wakeups.
482 * @param obj object that would be signaled (object lock MUST hold)
483 * @return a readable pipe descriptor, or -1 on error.
485 int vlc_object_waitpipe( vlc_object_t *obj )
487 int *pipes = obj->p_internals->pipes;
488 vlc_assert_locked( &obj->object_lock );
492 /* This can only ever happen if someone killed us without locking */
493 assert( pipes[0] == -1 );
508 * Waits for the object to be signaled (using vlc_object_signal()).
509 * If the object already has a signal pending, this function will return
510 * immediately. It is asserted that the caller holds the object lock.
512 * @return true if the object is dying and should terminate.
514 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
516 vlc_assert_locked( &obj->object_lock );
518 int fd = obj->p_internals->pipes[0];
521 if( read( fd, &(char){ 0 }, 1 ) == 0 )
524 obj->p_internals->pipes[1] = -1;
529 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
535 * Waits for the object to be signaled (using vlc_object_signal()), or for
537 * If the object already has a signal pending, this function will return
538 * immediately. It is asserted that the caller holds the object lock.
540 * @return negative if the object is dying and should terminate,
541 * positive if the the object has been signaled but is not dying,
542 * 0 if timeout has been reached.
544 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
548 vlc_assert_locked( &obj->object_lock );
549 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
550 if( v == 0 ) /* signaled */
551 return obj->b_die ? -1 : 1;
557 * Checks whether an object has been "killed".
558 * The object lock must be held.
560 * Typical code for an object thread could be:
562 vlc_object_lock (self);
564 while (vlc_object_alive (self))
568 if (vlc_object_wait (self))
573 ...deinitialization...
574 vlc_object_unlock (self);
577 * @return true iff the object has not been killed yet
579 vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
581 vlc_assert_locked( &obj->object_lock );
587 * Signals an object for which the lock is held.
589 void __vlc_object_signal_unlocked( vlc_object_t *obj )
591 vlc_assert_locked( &obj->object_lock );
593 int fd = obj->p_internals->pipes[1];
595 while( write( fd, &(char){ 0 }, 1 ) < 0 );
597 vlc_cond_signal( &obj->object_wait );
602 * Requests termination of an object.
603 * If the object is LibVLC, also request to terminate all its children.
605 void __vlc_object_kill( vlc_object_t *p_this )
607 vlc_mutex_lock( &p_this->object_lock );
608 p_this->b_die = VLC_TRUE;
610 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
611 for( int i = 0; i < p_this->i_children ; i++ )
612 vlc_object_kill( p_this->pp_children[i] );
614 int fd = p_this->p_internals->pipes[1];
617 close( fd ); /* closing a pipe makes it readable too */
618 p_this->p_internals->pipes[1] = -1;
621 vlc_object_signal_unlocked( p_this );
622 vlc_mutex_unlock( &p_this->object_lock );
627 * find an object given its ID
629 * This function looks for the object whose i_object_id field is i_id. We
630 * use a dichotomy so that lookups are in log2(n).
631 *****************************************************************************/
632 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
635 vlc_object_t **pp_objects;
636 libvlc_global_data_t *p_libvlc_global = vlc_global();
638 vlc_mutex_lock( &structure_lock );
640 pp_objects = p_libvlc_global->pp_objects;
642 /* Perform our dichotomy */
643 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
645 i_middle = i_max / 2;
647 if( pp_objects[i_middle]->i_object_id > i_id )
651 else if( pp_objects[i_middle]->i_object_id < i_id )
655 pp_objects += i_middle;
660 /* This happens when there are only two remaining objects */
661 if( pp_objects[i_middle+1]->i_object_id == i_id )
663 vlc_mutex_unlock( &structure_lock );
664 pp_objects[i_middle+1]->p_internals->i_refcount++;
665 return pp_objects[i_middle+1];
672 vlc_mutex_unlock( &structure_lock );
673 pp_objects[i_middle]->p_internals->i_refcount++;
674 return pp_objects[i_middle];
679 /* this means that i_max == i_middle, and since we have already
680 * tested pp_objects[i_middle]), p_found is properly set. */
685 vlc_mutex_unlock( &structure_lock );
690 ****************************************************************************
691 * find a typed object and increment its refcount
692 *****************************************************************************
693 * This function recursively looks for a given object type. i_mode can be one
694 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
695 *****************************************************************************/
696 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
698 vlc_object_t *p_found;
700 vlc_mutex_lock( &structure_lock );
702 /* If we are of the requested type ourselves, don't look further */
703 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
705 p_this->p_internals->i_refcount++;
706 vlc_mutex_unlock( &structure_lock );
710 /* Otherwise, recursively look for the object */
711 if( (i_mode & 0x000f) == FIND_ANYWHERE )
713 vlc_object_t *p_root = p_this;
716 while( p_root->p_parent != NULL &&
717 p_root != VLC_OBJECT( p_this->p_libvlc ) )
719 p_root = p_root->p_parent;
722 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
723 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
725 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
726 i_type, (i_mode & ~0x000f)|FIND_CHILD );
731 p_found = FindObject( p_this, i_type, i_mode );
734 vlc_mutex_unlock( &structure_lock );
740 ****************************************************************************
741 * find a named object and increment its refcount
742 *****************************************************************************
743 * This function recursively looks for a given object name. i_mode can be one
744 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
745 *****************************************************************************/
746 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
749 vlc_object_t *p_found;
751 vlc_mutex_lock( &structure_lock );
753 /* If have the requested name ourselves, don't look further */
754 if( !(i_mode & FIND_STRICT)
755 && p_this->psz_object_name
756 && !strcmp( p_this->psz_object_name, psz_name ) )
758 p_this->p_internals->i_refcount++;
759 vlc_mutex_unlock( &structure_lock );
763 /* Otherwise, recursively look for the object */
764 if( (i_mode & 0x000f) == FIND_ANYWHERE )
766 vlc_object_t *p_root = p_this;
769 while( p_root->p_parent != NULL &&
770 p_root != VLC_OBJECT( p_this->p_libvlc ) )
772 p_root = p_root->p_parent;
775 p_found = FindObjectName( p_root, psz_name,
776 (i_mode & ~0x000f)|FIND_CHILD );
777 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
779 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
780 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
785 p_found = FindObjectName( p_this, psz_name, i_mode );
788 vlc_mutex_unlock( &structure_lock );
794 ****************************************************************************
795 * increment an object refcount
796 *****************************************************************************/
797 void __vlc_object_yield( vlc_object_t *p_this )
799 vlc_mutex_lock( &structure_lock );
800 p_this->p_internals->i_refcount++;
801 vlc_mutex_unlock( &structure_lock );
804 static inline void Release( vlc_object_t *obj )
806 assert( obj->p_internals->i_refcount > 0 );
807 obj->p_internals->i_refcount--;
810 /*****************************************************************************
811 * decrement an object refcount
812 *****************************************************************************/
813 void __vlc_object_release( vlc_object_t *p_this )
815 vlc_mutex_lock( &structure_lock );
817 vlc_mutex_unlock( &structure_lock );
821 ****************************************************************************
822 * attach object to a parent object
823 *****************************************************************************
824 * This function sets p_this as a child of p_parent, and p_parent as a parent
825 * of p_this. This link can be undone using vlc_object_detach.
826 *****************************************************************************/
827 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
829 if( !p_this ) return;
831 vlc_mutex_lock( &structure_lock );
833 /* Attach the parent to its child */
834 p_this->p_parent = p_parent;
836 /* Attach the child to its parent */
837 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
838 p_parent->i_children, p_this );
840 /* Climb up the tree to see whether we are connected with the root */
841 if( p_parent->p_internals->b_attached )
843 SetAttachment( p_this, VLC_TRUE );
846 vlc_mutex_unlock( &structure_lock );
850 ****************************************************************************
851 * detach object from its parent
852 *****************************************************************************
853 * This function removes all links between an object and its parent.
854 *****************************************************************************/
855 void __vlc_object_detach( vlc_object_t *p_this )
857 if( !p_this ) return;
859 vlc_mutex_lock( &structure_lock );
860 if( !p_this->p_parent )
862 msg_Err( p_this, "object is not attached" );
863 vlc_mutex_unlock( &structure_lock );
867 /* Climb up the tree to see whether we are connected with the root */
868 if( p_this->p_parent->p_internals->b_attached )
870 SetAttachment( p_this, VLC_FALSE );
873 DetachObject( p_this );
874 vlc_mutex_unlock( &structure_lock );
879 ****************************************************************************
880 * find a list typed objects and increment their refcount
881 *****************************************************************************
882 * This function recursively looks for a given object type. i_mode can be one
883 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
884 *****************************************************************************/
885 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
888 vlc_object_t **pp_current, **pp_end;
889 int i_count = 0, i_index = 0;
890 libvlc_global_data_t *p_libvlc_global = vlc_global();
892 vlc_mutex_lock( &structure_lock );
894 /* Look for the objects */
895 switch( i_mode & 0x000f )
898 pp_current = p_libvlc_global->pp_objects;
899 pp_end = pp_current + p_libvlc_global->i_objects;
901 for( ; pp_current < pp_end ; pp_current++ )
903 if( (*pp_current)->p_internals->b_attached
904 && (*pp_current)->i_object_type == i_type )
910 p_list = NewList( i_count );
911 pp_current = p_libvlc_global->pp_objects;
913 for( ; pp_current < pp_end ; pp_current++ )
915 if( (*pp_current)->p_internals->b_attached
916 && (*pp_current)->i_object_type == i_type )
918 ListReplace( p_list, *pp_current, i_index );
919 if( i_index < i_count ) i_index++;
925 i_count = CountChildren( p_this, i_type );
926 p_list = NewList( i_count );
928 /* Check allocation was successful */
929 if( p_list->i_count != i_count )
931 msg_Err( p_this, "list allocation failed!" );
937 ListChildren( p_list, p_this, i_type );
941 msg_Err( p_this, "unimplemented!" );
942 p_list = NewList( 0 );
946 vlc_mutex_unlock( &structure_lock );
951 /*****************************************************************************
952 * DumpCommand: print the current vlc structure
953 *****************************************************************************
954 * This function prints either an ASCII tree showing the connections between
955 * vlc objects, and additional information such as their refcount, thread ID,
956 * etc. (command "tree"), or the same data as a simple list (command "list").
957 *****************************************************************************/
958 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
959 vlc_value_t oldval, vlc_value_t newval, void *p_data )
961 libvlc_global_data_t *p_libvlc_global = vlc_global();
963 (void)oldval; (void)p_data;
964 if( *psz_cmd == 'l' )
966 vlc_mutex_lock( &structure_lock );
968 vlc_object_t **pp_current, **pp_end;
970 pp_current = p_libvlc_global->pp_objects;
971 pp_end = pp_current + p_libvlc_global->i_objects;
973 for( ; pp_current < pp_end ; pp_current++ )
975 if( (*pp_current)->p_internals->b_attached )
977 PrintObject( *pp_current, "" );
981 printf( " o %.8i %s (not attached)\n",
982 (*pp_current)->i_object_id,
983 (*pp_current)->psz_object_type );
987 vlc_mutex_unlock( &structure_lock );
991 vlc_object_t *p_object = NULL;
993 if( *newval.psz_string )
996 int i_id = strtol( newval.psz_string, &end, 0 );
997 if( end != newval.psz_string )
998 p_object = vlc_object_get( p_this, i_id );
1001 /* try using the object's name to find it */
1002 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
1005 /* Look in p_libvlc's children tree */
1006 p_object = vlc_object_find_name( p_libvlc,
1009 vlc_object_release( p_libvlc );
1013 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1014 p_object = vlc_object_find_name( p_this,
1026 vlc_mutex_lock( &structure_lock );
1028 if( *psz_cmd == 't' )
1030 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1033 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1036 DumpStructure( p_object, 0, psz_foo );
1038 else if( *psz_cmd == 'v' )
1043 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1045 PrintObject( p_object, "" );
1047 if( !p_object->p_internals->i_vars )
1048 printf( " `-o No variables\n" );
1049 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1051 variable_t *p_var = p_object->p_internals->p_vars + i;
1053 const char *psz_type = "unknown";
1054 switch( p_var->i_type & VLC_VAR_TYPE )
1056 #define MYCASE( type, nice ) \
1057 case VLC_VAR_ ## type: \
1060 MYCASE( VOID, "void" );
1061 MYCASE( BOOL, "bool" );
1062 MYCASE( INTEGER, "integer" );
1063 MYCASE( HOTKEY, "hotkey" );
1064 MYCASE( STRING, "string" );
1065 MYCASE( MODULE, "module" );
1066 MYCASE( FILE, "file" );
1067 MYCASE( DIRECTORY, "directory" );
1068 MYCASE( VARIABLE, "variable" );
1069 MYCASE( FLOAT, "float" );
1070 MYCASE( TIME, "time" );
1071 MYCASE( ADDRESS, "address" );
1072 MYCASE( MUTEX, "mutex" );
1073 MYCASE( LIST, "list" );
1076 printf( " %c-o \"%s\" (%s",
1077 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1078 p_var->psz_name, psz_type );
1079 if( p_var->psz_text )
1080 printf( ", %s", p_var->psz_text );
1082 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1083 printf( ", command" );
1084 if( p_var->i_entries )
1085 printf( ", %d callbacks", p_var->i_entries );
1086 switch( p_var->i_type & 0x00f0 )
1092 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1094 case VLC_VAR_INTEGER:
1095 printf( ": %d", p_var->val.i_int );
1097 case VLC_VAR_STRING:
1098 printf( ": \"%s\"", p_var->val.psz_string );
1101 printf( ": %f", p_var->val.f_float );
1104 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1106 case VLC_VAR_ADDRESS:
1107 printf( ": %p", p_var->val.p_address );
1117 vlc_mutex_unlock( &structure_lock );
1119 if( *newval.psz_string )
1121 vlc_object_release( p_object );
1128 /*****************************************************************************
1129 * vlc_list_release: free a list previously allocated by vlc_list_find
1130 *****************************************************************************
1131 * This function decreases the refcount of all objects in the list and
1133 *****************************************************************************/
1134 void vlc_list_release( vlc_list_t *p_list )
1138 vlc_mutex_lock( &structure_lock );
1139 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1141 Release( p_list->p_values[i_index].p_object );
1143 vlc_mutex_unlock( &structure_lock );
1145 free( p_list->p_values );
1149 /* Following functions are local */
1151 /*****************************************************************************
1152 * FindIndex: find the index of an object in an array of objects
1153 *****************************************************************************
1154 * This function assumes that p_this can be found in pp_objects. It will not
1155 * crash if p_this cannot be found, but will return a wrong value. It is your
1156 * duty to check the return value if you are not certain that the object could
1157 * be found for sure.
1158 *****************************************************************************/
1159 static int FindIndex( vlc_object_t *p_this,
1160 vlc_object_t **pp_objects, int i_count )
1162 int i_middle = i_count / 2;
1169 if( pp_objects[i_middle] == p_this )
1179 /* We take advantage of the sorted array */
1180 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1182 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1183 i_count - i_middle );
1187 return FindIndex( p_this, pp_objects, i_middle );
1191 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1194 vlc_object_t *p_tmp;
1196 switch( i_mode & 0x000f )
1199 p_tmp = p_this->p_parent;
1202 if( p_tmp->i_object_type == i_type )
1204 p_tmp->p_internals->i_refcount++;
1209 return FindObject( p_tmp, i_type, i_mode );
1215 for( i = p_this->i_children; i--; )
1217 p_tmp = p_this->pp_children[i];
1218 if( p_tmp->i_object_type == i_type )
1220 p_tmp->p_internals->i_refcount++;
1223 else if( p_tmp->i_children )
1225 p_tmp = FindObject( p_tmp, i_type, i_mode );
1235 /* Handled in vlc_object_find */
1242 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1243 const char *psz_name,
1247 vlc_object_t *p_tmp;
1249 switch( i_mode & 0x000f )
1252 p_tmp = p_this->p_parent;
1255 if( p_tmp->psz_object_name
1256 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1258 p_tmp->p_internals->i_refcount++;
1263 return FindObjectName( p_tmp, psz_name, i_mode );
1269 for( i = p_this->i_children; i--; )
1271 p_tmp = p_this->pp_children[i];
1272 if( p_tmp->psz_object_name
1273 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1275 p_tmp->p_internals->i_refcount++;
1278 else if( p_tmp->i_children )
1280 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1290 /* Handled in vlc_object_find */
1297 static void DetachObject( vlc_object_t *p_this )
1299 vlc_object_t *p_parent = p_this->p_parent;
1302 /* Remove p_this's parent */
1303 p_this->p_parent = NULL;
1305 /* Remove all of p_parent's children which are p_this */
1306 for( i_index = p_parent->i_children ; i_index-- ; )
1308 if( p_parent->pp_children[i_index] == p_this )
1310 p_parent->i_children--;
1311 for( i = i_index ; i < p_parent->i_children ; i++ )
1313 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1318 if( p_parent->i_children )
1320 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1321 p_parent->i_children * sizeof(vlc_object_t *) );
1325 free( p_parent->pp_children );
1326 p_parent->pp_children = NULL;
1330 /*****************************************************************************
1331 * SetAttachment: recursively set the b_attached flag of a subtree.
1332 *****************************************************************************
1333 * This function is used by the attach and detach functions to propagate
1334 * the b_attached flag in a subtree.
1335 *****************************************************************************/
1336 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1340 for( i_index = p_this->i_children ; i_index-- ; )
1342 SetAttachment( p_this->pp_children[i_index], b_attached );
1345 p_this->p_internals->b_attached = b_attached;
1348 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1350 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1354 if( p_this->psz_object_name )
1356 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1358 psz_name[48] = '\"';
1361 psz_children[0] = '\0';
1362 switch( p_this->i_children )
1367 strcpy( psz_children, ", 1 child" );
1370 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1374 psz_refcount[0] = '\0';
1375 if( p_this->p_internals->i_refcount > 0 )
1376 snprintf( psz_refcount, 19, ", refcount %u",
1377 p_this->p_internals->i_refcount );
1379 psz_thread[0] = '\0';
1380 if( p_this->p_internals->b_thread )
1381 snprintf( psz_thread, 29, " (thread %u)",
1382 #if defined(WIN32) || defined(UNDER_CE)
1383 (unsigned)p_this->p_internals->thread_id.id );
1385 (unsigned)p_this->p_internals->thread_id );
1388 psz_parent[0] = '\0';
1389 if( p_this->p_parent )
1390 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1392 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1393 p_this->i_object_id, p_this->psz_object_type,
1394 psz_name, psz_thread, psz_refcount, psz_children,
1398 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1401 char i_back = psz_foo[i_level];
1402 psz_foo[i_level] = '\0';
1404 PrintObject( p_this, psz_foo );
1406 psz_foo[i_level] = i_back;
1408 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1410 msg_Warn( p_this, "structure tree is too deep" );
1414 for( i = 0 ; i < p_this->i_children ; i++ )
1418 psz_foo[i_level-1] = ' ';
1420 if( psz_foo[i_level-2] == '`' )
1422 psz_foo[i_level-2] = ' ';
1426 if( i == p_this->i_children - 1 )
1428 psz_foo[i_level] = '`';
1432 psz_foo[i_level] = '|';
1435 psz_foo[i_level+1] = '-';
1436 psz_foo[i_level+2] = '\0';
1438 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1442 static vlc_list_t * NewList( int i_count )
1444 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1445 if( p_list == NULL )
1450 p_list->i_count = i_count;
1454 p_list->p_values = NULL;
1458 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1459 if( p_list->p_values == NULL )
1461 p_list->i_count = 0;
1468 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1471 if( p_list == NULL || i_index >= p_list->i_count )
1476 p_object->p_internals->i_refcount++;
1478 p_list->p_values[i_index].p_object = p_object;
1483 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1485 if( p_list == NULL )
1490 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1491 * sizeof( vlc_value_t ) );
1492 if( p_list->p_values == NULL )
1494 p_list->i_count = 0;
1498 p_object->p_internals->i_refcount++;
1500 p_list->p_values[p_list->i_count].p_object = p_object;
1506 static int CountChildren( vlc_object_t *p_this, int i_type )
1508 vlc_object_t *p_tmp;
1511 for( i = 0; i < p_this->i_children; i++ )
1513 p_tmp = p_this->pp_children[i];
1515 if( p_tmp->i_object_type == i_type )
1520 if( p_tmp->i_children )
1522 i_count += CountChildren( p_tmp, i_type );
1529 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1531 vlc_object_t *p_tmp;
1534 for( i = 0; i < p_this->i_children; i++ )
1536 p_tmp = p_this->pp_children[i];
1538 if( p_tmp->i_object_type == i_type )
1540 ListReplace( p_list, p_tmp, p_list->i_count++ );
1543 if( p_tmp->i_children )
1545 ListChildren( p_list, p_tmp, i_type );