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 # include <winsock2.h>
472 # include <ws2tcpip.h>
475 * select()-able pipes emulated using Winsock
477 static int pipe (int fd[2])
480 int addrlen = sizeof (addr);
482 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
483 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
484 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
487 memset (&addr, 0, sizeof (addr));
488 addr.sin_family = AF_INET;
489 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
490 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
491 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
493 || connect (c, (PSOCKADDR)&addr, addrlen))
496 a = accept (l, NULL, NULL);
497 if (a == INVALID_SOCKET)
508 if (l != INVALID_SOCKET)
510 if (c != INVALID_SOCKET)
516 #define read( a, b, c ) recv (a, b, c, 0)
518 #define write( a, b, c ) send (a, b, c, 0)
520 #define close( a ) closesocket (a)
524 * Returns the readable end of a pipe that becomes readable whenever
525 * an object is signaled. This can be used to wait for VLC object events
526 * inside select(), poll() loops or frameworks providing an event loop.
528 * Note that the pipe will remain the same for the lifetime of the object.
529 * DO NOT close it yourself. Ever.
531 * DO NOT try to read from the pipe either: call vlc_object_wait() instead.
532 * Assuming the pipe is readable, vlc_object_wait() will not block.
533 * Also note that, as with vlc_object_wait(), there may be spurious wakeups.
535 * @param obj object that would be signaled (object lock MUST hold)
536 * @return a readable pipe descriptor, or -1 on error.
538 int __vlc_object_waitpipe( vlc_object_t *obj )
540 int *pipes = obj->p_internals->pipes;
541 vlc_assert_locked( &obj->object_lock );
545 /* This can only ever happen if someone killed us without locking */
546 assert( pipes[0] == -1 );
557 * Waits for the object to be signaled (using vlc_object_signal()).
558 * If the object already has a signal pending, this function will return
559 * immediately. It is asserted that the caller holds the object lock.
561 * @return true if the object is dying and should terminate.
563 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
565 vlc_assert_locked( &obj->object_lock );
567 int fd = obj->p_internals->pipes[0];
570 if( read( fd, &(char){ 0 }, 1 ) == 0 )
573 obj->p_internals->pipes[1] = -1;
578 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
584 * Waits for the object to be signaled (using vlc_object_signal()), or for
586 * If the object already has a signal pending, this function will return
587 * immediately. It is asserted that the caller holds the object lock.
589 * @return negative if the object is dying and should terminate,
590 * positive if the the object has been signaled but is not dying,
591 * 0 if timeout has been reached.
593 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
597 vlc_assert_locked( &obj->object_lock );
598 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
599 if( v == 0 ) /* signaled */
600 return obj->b_die ? -1 : 1;
606 * Checks whether an object has been "killed".
607 * The object lock must be held.
609 * Typical code for an object thread could be:
611 vlc_object_lock (self);
613 while (vlc_object_alive (self))
617 if (vlc_object_wait (self))
622 ...deinitialization...
623 vlc_object_unlock (self);
626 * @return true iff the object has not been killed yet
628 vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
630 vlc_assert_locked( &obj->object_lock );
636 * Signals an object for which the lock is held.
638 void __vlc_object_signal_unlocked( vlc_object_t *obj )
640 vlc_assert_locked( &obj->object_lock );
642 int fd = obj->p_internals->pipes[1];
644 while( write( fd, &(char){ 0 }, 1 ) < 0 );
646 vlc_cond_signal( &obj->object_wait );
651 * Requests termination of an object.
652 * If the object is LibVLC, also request to terminate all its children.
654 void __vlc_object_kill( vlc_object_t *p_this )
656 vlc_mutex_lock( &p_this->object_lock );
657 p_this->b_die = VLC_TRUE;
659 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
660 for( int i = 0; i < p_this->i_children ; i++ )
661 vlc_object_kill( p_this->pp_children[i] );
663 int fd = p_this->p_internals->pipes[1];
666 close( fd ); /* closing a pipe makes it readable too */
667 p_this->p_internals->pipes[1] = -1;
670 vlc_object_signal_unlocked( p_this );
671 vlc_mutex_unlock( &p_this->object_lock );
676 * find an object given its ID
678 * This function looks for the object whose i_object_id field is i_id. We
679 * use a dichotomy so that lookups are in log2(n).
680 *****************************************************************************/
681 void * __vlc_object_get( vlc_object_t *p_this, int i_id )
684 vlc_object_t **pp_objects;
685 libvlc_global_data_t *p_libvlc_global = vlc_global();
687 vlc_mutex_lock( &structure_lock );
689 pp_objects = p_libvlc_global->pp_objects;
691 /* Perform our dichotomy */
692 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
694 i_middle = i_max / 2;
696 if( pp_objects[i_middle]->i_object_id > i_id )
700 else if( pp_objects[i_middle]->i_object_id < i_id )
704 pp_objects += i_middle;
709 /* This happens when there are only two remaining objects */
710 if( pp_objects[i_middle+1]->i_object_id == i_id )
712 vlc_mutex_unlock( &structure_lock );
713 pp_objects[i_middle+1]->p_internals->i_refcount++;
714 return pp_objects[i_middle+1];
721 vlc_mutex_unlock( &structure_lock );
722 pp_objects[i_middle]->p_internals->i_refcount++;
723 return pp_objects[i_middle];
728 /* this means that i_max == i_middle, and since we have already
729 * tested pp_objects[i_middle]), p_found is properly set. */
734 vlc_mutex_unlock( &structure_lock );
739 ****************************************************************************
740 * find a typed object and increment its refcount
741 *****************************************************************************
742 * This function recursively looks for a given object type. i_mode can be one
743 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
744 *****************************************************************************/
745 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
747 vlc_object_t *p_found;
749 vlc_mutex_lock( &structure_lock );
751 /* If we are of the requested type ourselves, don't look further */
752 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
754 p_this->p_internals->i_refcount++;
755 vlc_mutex_unlock( &structure_lock );
759 /* Otherwise, recursively look for the object */
760 if( (i_mode & 0x000f) == FIND_ANYWHERE )
762 vlc_object_t *p_root = p_this;
765 while( p_root->p_parent != NULL &&
766 p_root != VLC_OBJECT( p_this->p_libvlc ) )
768 p_root = p_root->p_parent;
771 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
772 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
774 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
775 i_type, (i_mode & ~0x000f)|FIND_CHILD );
780 p_found = FindObject( p_this, i_type, i_mode );
783 vlc_mutex_unlock( &structure_lock );
789 ****************************************************************************
790 * find a named object and increment its refcount
791 *****************************************************************************
792 * This function recursively looks for a given object name. i_mode can be one
793 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
794 *****************************************************************************/
795 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
798 vlc_object_t *p_found;
800 vlc_mutex_lock( &structure_lock );
802 /* If have the requested name ourselves, don't look further */
803 if( !(i_mode & FIND_STRICT)
804 && p_this->psz_object_name
805 && !strcmp( p_this->psz_object_name, psz_name ) )
807 p_this->p_internals->i_refcount++;
808 vlc_mutex_unlock( &structure_lock );
812 /* Otherwise, recursively look for the object */
813 if( (i_mode & 0x000f) == FIND_ANYWHERE )
815 vlc_object_t *p_root = p_this;
818 while( p_root->p_parent != NULL &&
819 p_root != VLC_OBJECT( p_this->p_libvlc ) )
821 p_root = p_root->p_parent;
824 p_found = FindObjectName( p_root, psz_name,
825 (i_mode & ~0x000f)|FIND_CHILD );
826 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
828 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
829 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
834 p_found = FindObjectName( p_this, psz_name, i_mode );
837 vlc_mutex_unlock( &structure_lock );
843 ****************************************************************************
844 * increment an object refcount
845 *****************************************************************************/
846 void __vlc_object_yield( vlc_object_t *p_this )
848 vlc_mutex_lock( &structure_lock );
849 p_this->p_internals->i_refcount++;
850 vlc_mutex_unlock( &structure_lock );
853 static inline void Release( vlc_object_t *obj )
855 assert( obj->p_internals->i_refcount > 0 );
856 obj->p_internals->i_refcount--;
859 /*****************************************************************************
860 * decrement an object refcount
861 *****************************************************************************/
862 void __vlc_object_release( vlc_object_t *p_this )
864 vlc_mutex_lock( &structure_lock );
866 vlc_mutex_unlock( &structure_lock );
870 ****************************************************************************
871 * attach object to a parent object
872 *****************************************************************************
873 * This function sets p_this as a child of p_parent, and p_parent as a parent
874 * of p_this. This link can be undone using vlc_object_detach.
875 *****************************************************************************/
876 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
878 if( !p_this ) return;
880 vlc_mutex_lock( &structure_lock );
882 /* Attach the parent to its child */
883 p_this->p_parent = p_parent;
885 /* Attach the child to its parent */
886 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
887 p_parent->i_children, p_this );
889 /* Climb up the tree to see whether we are connected with the root */
890 if( p_parent->p_internals->b_attached )
892 SetAttachment( p_this, VLC_TRUE );
895 vlc_mutex_unlock( &structure_lock );
899 ****************************************************************************
900 * detach object from its parent
901 *****************************************************************************
902 * This function removes all links between an object and its parent.
903 *****************************************************************************/
904 void __vlc_object_detach( vlc_object_t *p_this )
906 if( !p_this ) return;
908 vlc_mutex_lock( &structure_lock );
909 if( !p_this->p_parent )
911 msg_Err( p_this, "object is not attached" );
912 vlc_mutex_unlock( &structure_lock );
916 /* Climb up the tree to see whether we are connected with the root */
917 if( p_this->p_parent->p_internals->b_attached )
919 SetAttachment( p_this, VLC_FALSE );
922 DetachObject( p_this );
923 vlc_mutex_unlock( &structure_lock );
928 ****************************************************************************
929 * find a list typed objects and increment their refcount
930 *****************************************************************************
931 * This function recursively looks for a given object type. i_mode can be one
932 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
933 *****************************************************************************/
934 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
937 vlc_object_t **pp_current, **pp_end;
938 int i_count = 0, i_index = 0;
939 libvlc_global_data_t *p_libvlc_global = vlc_global();
941 vlc_mutex_lock( &structure_lock );
943 /* Look for the objects */
944 switch( i_mode & 0x000f )
947 pp_current = p_libvlc_global->pp_objects;
948 pp_end = pp_current + p_libvlc_global->i_objects;
950 for( ; pp_current < pp_end ; pp_current++ )
952 if( (*pp_current)->p_internals->b_attached
953 && (*pp_current)->i_object_type == i_type )
959 p_list = NewList( i_count );
960 pp_current = p_libvlc_global->pp_objects;
962 for( ; pp_current < pp_end ; pp_current++ )
964 if( (*pp_current)->p_internals->b_attached
965 && (*pp_current)->i_object_type == i_type )
967 ListReplace( p_list, *pp_current, i_index );
968 if( i_index < i_count ) i_index++;
974 i_count = CountChildren( p_this, i_type );
975 p_list = NewList( i_count );
977 /* Check allocation was successful */
978 if( p_list->i_count != i_count )
980 msg_Err( p_this, "list allocation failed!" );
986 ListChildren( p_list, p_this, i_type );
990 msg_Err( p_this, "unimplemented!" );
991 p_list = NewList( 0 );
995 vlc_mutex_unlock( &structure_lock );
1000 /*****************************************************************************
1001 * DumpCommand: print the current vlc structure
1002 *****************************************************************************
1003 * This function prints either an ASCII tree showing the connections between
1004 * vlc objects, and additional information such as their refcount, thread ID,
1005 * etc. (command "tree"), or the same data as a simple list (command "list").
1006 *****************************************************************************/
1007 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1008 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1010 libvlc_global_data_t *p_libvlc_global = vlc_global();
1012 (void)oldval; (void)p_data;
1013 if( *psz_cmd == 'l' )
1015 vlc_mutex_lock( &structure_lock );
1017 vlc_object_t **pp_current, **pp_end;
1019 pp_current = p_libvlc_global->pp_objects;
1020 pp_end = pp_current + p_libvlc_global->i_objects;
1022 for( ; pp_current < pp_end ; pp_current++ )
1024 if( (*pp_current)->p_internals->b_attached )
1026 PrintObject( *pp_current, "" );
1030 printf( " o %.8i %s (not attached)\n",
1031 (*pp_current)->i_object_id,
1032 (*pp_current)->psz_object_type );
1036 vlc_mutex_unlock( &structure_lock );
1040 vlc_object_t *p_object = NULL;
1042 if( *newval.psz_string )
1045 int i_id = strtol( newval.psz_string, &end, 0 );
1046 if( end != newval.psz_string )
1047 p_object = vlc_object_get( p_this, i_id );
1050 /* try using the object's name to find it */
1051 vlc_object_t *p_libvlc = vlc_object_get( p_this, 1 );
1054 /* Look in p_libvlc's children tree */
1055 p_object = vlc_object_find_name( p_libvlc,
1058 vlc_object_release( p_libvlc );
1062 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1063 p_object = vlc_object_find_name( p_this,
1075 vlc_mutex_lock( &structure_lock );
1077 if( *psz_cmd == 't' )
1079 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1082 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1085 DumpStructure( p_object, 0, psz_foo );
1087 else if( *psz_cmd == 'v' )
1092 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1094 PrintObject( p_object, "" );
1096 if( !p_object->p_internals->i_vars )
1097 printf( " `-o No variables\n" );
1098 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1100 variable_t *p_var = p_object->p_internals->p_vars + i;
1102 const char *psz_type = "unknown";
1103 switch( p_var->i_type & VLC_VAR_TYPE )
1105 #define MYCASE( type, nice ) \
1106 case VLC_VAR_ ## type: \
1109 MYCASE( VOID, "void" );
1110 MYCASE( BOOL, "bool" );
1111 MYCASE( INTEGER, "integer" );
1112 MYCASE( HOTKEY, "hotkey" );
1113 MYCASE( STRING, "string" );
1114 MYCASE( MODULE, "module" );
1115 MYCASE( FILE, "file" );
1116 MYCASE( DIRECTORY, "directory" );
1117 MYCASE( VARIABLE, "variable" );
1118 MYCASE( FLOAT, "float" );
1119 MYCASE( TIME, "time" );
1120 MYCASE( ADDRESS, "address" );
1121 MYCASE( MUTEX, "mutex" );
1122 MYCASE( LIST, "list" );
1125 printf( " %c-o \"%s\" (%s",
1126 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1127 p_var->psz_name, psz_type );
1128 if( p_var->psz_text )
1129 printf( ", %s", p_var->psz_text );
1131 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1132 printf( ", command" );
1133 if( p_var->i_entries )
1134 printf( ", %d callbacks", p_var->i_entries );
1135 switch( p_var->i_type & 0x00f0 )
1141 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1143 case VLC_VAR_INTEGER:
1144 printf( ": %d", p_var->val.i_int );
1146 case VLC_VAR_STRING:
1147 printf( ": \"%s\"", p_var->val.psz_string );
1150 printf( ": %f", p_var->val.f_float );
1153 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1155 case VLC_VAR_ADDRESS:
1156 printf( ": %p", p_var->val.p_address );
1166 vlc_mutex_unlock( &structure_lock );
1168 if( *newval.psz_string )
1170 vlc_object_release( p_object );
1177 /*****************************************************************************
1178 * vlc_list_release: free a list previously allocated by vlc_list_find
1179 *****************************************************************************
1180 * This function decreases the refcount of all objects in the list and
1182 *****************************************************************************/
1183 void vlc_list_release( vlc_list_t *p_list )
1187 vlc_mutex_lock( &structure_lock );
1188 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1190 Release( p_list->p_values[i_index].p_object );
1192 vlc_mutex_unlock( &structure_lock );
1194 free( p_list->p_values );
1198 /* Following functions are local */
1200 /*****************************************************************************
1201 * FindIndex: find the index of an object in an array of objects
1202 *****************************************************************************
1203 * This function assumes that p_this can be found in pp_objects. It will not
1204 * crash if p_this cannot be found, but will return a wrong value. It is your
1205 * duty to check the return value if you are not certain that the object could
1206 * be found for sure.
1207 *****************************************************************************/
1208 static int FindIndex( vlc_object_t *p_this,
1209 vlc_object_t **pp_objects, int i_count )
1211 int i_middle = i_count / 2;
1218 if( pp_objects[i_middle] == p_this )
1228 /* We take advantage of the sorted array */
1229 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1231 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1232 i_count - i_middle );
1236 return FindIndex( p_this, pp_objects, i_middle );
1240 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1243 vlc_object_t *p_tmp;
1245 switch( i_mode & 0x000f )
1248 p_tmp = p_this->p_parent;
1251 if( p_tmp->i_object_type == i_type )
1253 p_tmp->p_internals->i_refcount++;
1258 return FindObject( p_tmp, i_type, i_mode );
1264 for( i = p_this->i_children; i--; )
1266 p_tmp = p_this->pp_children[i];
1267 if( p_tmp->i_object_type == i_type )
1269 p_tmp->p_internals->i_refcount++;
1272 else if( p_tmp->i_children )
1274 p_tmp = FindObject( p_tmp, i_type, i_mode );
1284 /* Handled in vlc_object_find */
1291 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1292 const char *psz_name,
1296 vlc_object_t *p_tmp;
1298 switch( i_mode & 0x000f )
1301 p_tmp = p_this->p_parent;
1304 if( p_tmp->psz_object_name
1305 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1307 p_tmp->p_internals->i_refcount++;
1312 return FindObjectName( p_tmp, psz_name, i_mode );
1318 for( i = p_this->i_children; i--; )
1320 p_tmp = p_this->pp_children[i];
1321 if( p_tmp->psz_object_name
1322 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1324 p_tmp->p_internals->i_refcount++;
1327 else if( p_tmp->i_children )
1329 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1339 /* Handled in vlc_object_find */
1346 static void DetachObject( vlc_object_t *p_this )
1348 vlc_object_t *p_parent = p_this->p_parent;
1351 /* Remove p_this's parent */
1352 p_this->p_parent = NULL;
1354 /* Remove all of p_parent's children which are p_this */
1355 for( i_index = p_parent->i_children ; i_index-- ; )
1357 if( p_parent->pp_children[i_index] == p_this )
1359 p_parent->i_children--;
1360 for( i = i_index ; i < p_parent->i_children ; i++ )
1362 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1367 if( p_parent->i_children )
1369 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1370 p_parent->i_children * sizeof(vlc_object_t *) );
1374 free( p_parent->pp_children );
1375 p_parent->pp_children = NULL;
1379 /*****************************************************************************
1380 * SetAttachment: recursively set the b_attached flag of a subtree.
1381 *****************************************************************************
1382 * This function is used by the attach and detach functions to propagate
1383 * the b_attached flag in a subtree.
1384 *****************************************************************************/
1385 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1389 for( i_index = p_this->i_children ; i_index-- ; )
1391 SetAttachment( p_this->pp_children[i_index], b_attached );
1394 p_this->p_internals->b_attached = b_attached;
1397 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1399 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1403 if( p_this->psz_object_name )
1405 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1407 psz_name[48] = '\"';
1410 psz_children[0] = '\0';
1411 switch( p_this->i_children )
1416 strcpy( psz_children, ", 1 child" );
1419 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1423 psz_refcount[0] = '\0';
1424 if( p_this->p_internals->i_refcount > 0 )
1425 snprintf( psz_refcount, 19, ", refcount %u",
1426 p_this->p_internals->i_refcount );
1428 psz_thread[0] = '\0';
1429 if( p_this->p_internals->b_thread )
1430 snprintf( psz_thread, 29, " (thread %u)",
1431 #if defined(WIN32) || defined(UNDER_CE)
1432 (unsigned)p_this->p_internals->thread_id.id );
1434 (unsigned)p_this->p_internals->thread_id );
1437 psz_parent[0] = '\0';
1438 if( p_this->p_parent )
1439 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1441 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1442 p_this->i_object_id, p_this->psz_object_type,
1443 psz_name, psz_thread, psz_refcount, psz_children,
1447 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1450 char i_back = psz_foo[i_level];
1451 psz_foo[i_level] = '\0';
1453 PrintObject( p_this, psz_foo );
1455 psz_foo[i_level] = i_back;
1457 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1459 msg_Warn( p_this, "structure tree is too deep" );
1463 for( i = 0 ; i < p_this->i_children ; i++ )
1467 psz_foo[i_level-1] = ' ';
1469 if( psz_foo[i_level-2] == '`' )
1471 psz_foo[i_level-2] = ' ';
1475 if( i == p_this->i_children - 1 )
1477 psz_foo[i_level] = '`';
1481 psz_foo[i_level] = '|';
1484 psz_foo[i_level+1] = '-';
1485 psz_foo[i_level+2] = '\0';
1487 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1491 static vlc_list_t * NewList( int i_count )
1493 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1494 if( p_list == NULL )
1499 p_list->i_count = i_count;
1503 p_list->p_values = NULL;
1507 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1508 if( p_list->p_values == NULL )
1510 p_list->i_count = 0;
1517 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1520 if( p_list == NULL || i_index >= p_list->i_count )
1525 p_object->p_internals->i_refcount++;
1527 p_list->p_values[i_index].p_object = p_object;
1532 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1534 if( p_list == NULL )
1539 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1540 * sizeof( vlc_value_t ) );
1541 if( p_list->p_values == NULL )
1543 p_list->i_count = 0;
1547 p_object->p_internals->i_refcount++;
1549 p_list->p_values[p_list->i_count].p_object = p_object;
1555 static int CountChildren( vlc_object_t *p_this, int i_type )
1557 vlc_object_t *p_tmp;
1560 for( i = 0; i < p_this->i_children; i++ )
1562 p_tmp = p_this->pp_children[i];
1564 if( p_tmp->i_object_type == i_type )
1569 if( p_tmp->i_children )
1571 i_count += CountChildren( p_tmp, i_type );
1578 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1580 vlc_object_t *p_tmp;
1583 for( i = 0; i < p_this->i_children; i++ )
1585 p_tmp = p_this->pp_children[i];
1587 if( p_tmp->i_object_type == i_type )
1589 ListReplace( p_list, p_tmp, p_list->i_count++ );
1592 if( p_tmp->i_children )
1594 ListChildren( p_list, p_tmp, i_type );