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 *****************************************************************************/
39 #include "../libvlc.h"
42 #include "audio_output/aout_internal.h"
44 #include <vlc_access.h>
45 #include <vlc_demux.h>
46 #include <vlc_stream.h>
49 #include "stream_output/stream_output.h"
51 #include "vlc_playlist.h"
52 #include "vlc_interface.h"
53 #include "vlc_codec.h"
54 #include "vlc_filter.h"
56 #include "vlc_httpd.h"
58 #include "input/vlm_internal.h"
65 #include "variables.h"
71 # include <errno.h> /* ENOSYS */
75 /*****************************************************************************
77 *****************************************************************************/
78 static int DumpCommand( vlc_object_t *, char const *,
79 vlc_value_t, vlc_value_t, void * );
81 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
82 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
83 static void DetachObject ( vlc_object_t * );
84 static void PrintObject ( vlc_object_t *, const char * );
85 static void DumpStructure ( vlc_object_t *, int, char * );
86 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
87 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
89 static vlc_list_t * NewList ( int );
90 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
91 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
92 static int CountChildren ( vlc_object_t *, int );
93 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
95 static void vlc_object_destroy( vlc_object_t *p_this );
96 static void vlc_object_yield_locked( vlc_object_t *p_this );
98 /*****************************************************************************
99 * Local structure lock
100 *****************************************************************************/
101 static vlc_mutex_t structure_lock;
102 static vlc_object_internals_t global_internals;
104 vlc_object_t *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
105 int i_type, const char *psz_type )
108 vlc_object_internals_t *p_priv;
110 if( i_type == VLC_OBJECT_GLOBAL )
113 p_priv = &global_internals;
114 memset( p_priv, 0, sizeof( *p_priv ) );
118 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
122 p_new = (vlc_object_t *)(p_priv + 1);
125 p_new->p_internals = p_priv;
126 p_new->i_object_type = i_type;
127 p_new->psz_object_type = psz_type;
129 p_new->psz_object_name = NULL;
131 p_new->b_die = VLC_FALSE;
132 p_new->b_error = VLC_FALSE;
133 p_new->b_dead = VLC_FALSE;
134 p_priv->b_attached = VLC_FALSE;
135 p_new->b_force = VLC_FALSE;
137 p_new->psz_header = NULL;
139 if( p_this->i_flags & OBJECT_FLAGS_NODBG )
140 p_new->i_flags |= OBJECT_FLAGS_NODBG;
141 if( p_this->i_flags & OBJECT_FLAGS_QUIET )
142 p_new->i_flags |= OBJECT_FLAGS_QUIET;
143 if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
144 p_new->i_flags |= OBJECT_FLAGS_NOINTERACT;
146 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
148 if( !p_priv->p_vars )
150 if( i_type != VLC_OBJECT_GLOBAL )
155 if( i_type == VLC_OBJECT_GLOBAL )
157 /* If i_type is global, then p_new is actually p_libvlc_global */
158 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
159 p_new->p_libvlc = NULL;
161 p_libvlc_global->i_counter = 0;
162 p_new->i_object_id = 0;
164 p_libvlc_global->i_objects = 1;
165 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
166 p_libvlc_global->pp_objects[0] = p_new;
167 p_priv->b_attached = VLC_TRUE;
171 libvlc_global_data_t *p_libvlc_global = vlc_global();
172 if( i_type == VLC_OBJECT_LIBVLC )
174 p_new->p_libvlc = (libvlc_int_t*)p_new;
175 p_priv->b_attached = VLC_TRUE;
179 p_new->p_libvlc = p_this->p_libvlc;
182 vlc_mutex_lock( &structure_lock );
184 p_libvlc_global->i_counter++;
185 p_new->i_object_id = p_libvlc_global->i_counter;
187 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
188 * useless to try and recover anything if pp_objects gets smashed. */
189 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
192 vlc_mutex_unlock( &structure_lock );
195 p_priv->i_refcount = 1;
196 p_new->p_parent = NULL;
197 p_new->pp_children = NULL;
198 p_new->i_children = 0;
200 p_new->p_private = NULL;
202 /* Initialize mutexes and condvars */
203 vlc_mutex_init( p_new, &p_new->object_lock );
204 vlc_cond_init( p_new, &p_new->object_wait );
205 vlc_mutex_init( p_new, &p_priv->var_lock );
206 vlc_spin_init( &p_priv->spin );
207 p_priv->pipes[0] = p_priv->pipes[1] = -1;
209 if( i_type == VLC_OBJECT_GLOBAL )
211 vlc_mutex_init( p_new, &structure_lock );
214 if( i_type == VLC_OBJECT_LIBVLC )
216 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
217 var_AddCallback( p_new, "list", DumpCommand, NULL );
218 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
219 var_AddCallback( p_new, "tree", DumpCommand, NULL );
220 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
221 var_AddCallback( p_new, "vars", DumpCommand, NULL );
229 * Allocates and initializes a vlc object.
231 * @param i_type known object type (all of them are negative integer values),
232 * or object byte size (always positive).
234 * @return the new object, or NULL on error.
236 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
238 const char * psz_type;
243 case VLC_OBJECT_GLOBAL:
244 i_size = sizeof(libvlc_global_data_t);
247 case VLC_OBJECT_LIBVLC:
248 i_size = sizeof(libvlc_int_t);
251 case VLC_OBJECT_INTF:
252 i_size = sizeof(intf_thread_t);
253 psz_type = "interface";
255 case VLC_OBJECT_DIALOGS:
256 i_size = sizeof(intf_thread_t);
257 psz_type = "dialogs";
259 case VLC_OBJECT_PLAYLIST:
260 i_size = sizeof(playlist_t);
261 psz_type = "playlist";
264 i_size = sizeof(services_discovery_t);
265 psz_type = "services discovery";
267 case VLC_OBJECT_INPUT:
268 i_size = sizeof(input_thread_t);
271 case VLC_OBJECT_DEMUX:
272 i_size = sizeof(demux_t);
275 case VLC_OBJECT_ACCESS:
276 i_size = sizeof(access_t);
279 case VLC_OBJECT_DECODER:
280 i_size = sizeof(decoder_t);
281 psz_type = "decoder";
283 case VLC_OBJECT_PACKETIZER:
284 i_size = sizeof(decoder_t);
285 psz_type = "packetizer";
287 case VLC_OBJECT_ENCODER:
288 i_size = sizeof(encoder_t);
289 psz_type = "encoder";
291 case VLC_OBJECT_FILTER:
292 i_size = sizeof(filter_t);
295 case VLC_OBJECT_VOUT:
296 i_size = sizeof(vout_thread_t);
297 psz_type = "video output";
300 i_size = sizeof(spu_t);
301 psz_type = "subpicture";
303 case VLC_OBJECT_AOUT:
304 i_size = sizeof(aout_instance_t);
305 psz_type = "audio output";
307 case VLC_OBJECT_SOUT:
308 i_size = sizeof(sout_instance_t);
309 psz_type = "stream output";
312 i_size = sizeof( vlm_t );
313 psz_type = "vlm dameon";
316 i_size = sizeof( vod_t );
317 psz_type = "vod server";
320 i_size = sizeof( xml_t );
323 case VLC_OBJECT_OPENGL:
324 i_size = sizeof( vout_thread_t );
327 case VLC_OBJECT_ANNOUNCE:
328 i_size = sizeof( announce_handler_t );
329 psz_type = "announce";
331 case VLC_OBJECT_META_ENGINE:
332 i_size = sizeof( meta_engine_t );
333 psz_type = "meta engine";
335 case VLC_OBJECT_OSDMENU:
336 i_size = sizeof( osd_menu_t );
337 psz_type = "osd menu";
339 case VLC_OBJECT_INTERACTION:
340 i_size = sizeof( interaction_t );
341 psz_type = "interaction";
344 i_size = i_type > (int)sizeof(vlc_object_t)
345 ? i_type : (int)sizeof(vlc_object_t);
346 i_type = VLC_OBJECT_GENERIC;
347 psz_type = "generic";
351 return vlc_custom_create( p_this, i_size, i_type, psz_type );
356 ****************************************************************************
357 * Destroy a vlc object (Internal)
359 * This function destroys an object that has been previously allocated with
360 * vlc_object_create. The object's refcount must be zero and it must not be
361 * attached to other objects in any way.
362 *****************************************************************************/
363 static void vlc_object_destroy( vlc_object_t *p_this )
365 vlc_object_internals_t *p_priv = vlc_internals( p_this );
368 if( p_this->i_children )
373 "ERROR: cannot delete object (%i, %s) with %d children\n",
374 p_this->i_object_id, p_this->psz_object_name,
375 p_this->i_children );
377 for( i = 0; i < p_this->i_children; i++ )
380 "ERROR: Remaining children object "
381 "(id:%i, type:%s, name:%s)\n",
382 p_this->pp_children[i]->i_object_id,
383 p_this->pp_children[i]->psz_object_type,
384 p_this->pp_children[i]->psz_object_name );
390 if( p_this->p_parent )
393 "ERROR: cannot delete object (id:%i, type:%s, name:%s) "
394 "with a parent (id:%i, type:%s, name:%s)\n",
395 p_this->i_object_id, p_this->psz_object_type,
396 p_this->psz_object_name, p_this->p_parent->i_object_id,
397 p_this->p_parent->psz_object_type,
398 p_this->p_parent->psz_object_name );
403 /* Destroy the associated variables, starting from the end so that
404 * no memmove calls have to be done. */
405 while( p_priv->i_vars )
407 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
410 free( p_priv->p_vars );
411 vlc_mutex_destroy( &p_priv->var_lock );
413 free( p_this->psz_header );
415 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
417 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
420 if( p_global->i_objects > 0 )
423 for( i = 0; i < p_global->i_objects; i++ )
425 /* We are leaking this object */
427 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
428 p_global->pp_objects[i]->i_object_id,
429 p_global->pp_objects[i]->psz_object_type,
430 p_global->pp_objects[i]->psz_object_name );
433 /* Strongly abort, cause we want these to be fixed */
437 /* We are the global object ... no need to lock. */
438 free( p_global->pp_objects );
439 p_global->pp_objects = NULL;
441 vlc_mutex_destroy( &structure_lock );
444 #if defined(WIN32) || defined(UNDER_CE)
445 /* if object has an associated thread, close it now */
446 if( p_priv->thread_id.hThread )
447 CloseHandle(p_priv->thread_id.hThread);
450 vlc_mutex_destroy( &p_this->object_lock );
451 vlc_cond_destroy( &p_this->object_wait );
452 vlc_spin_destroy( &p_priv->spin );
453 if( p_priv->pipes[1] != -1 )
454 close( p_priv->pipes[1] );
455 if( p_priv->pipes[0] != -1 )
456 close( p_priv->pipes[0] );
458 /* global is not dynamically allocated by vlc_object_create */
459 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
464 /** Inter-object signaling */
466 void __vlc_object_lock( vlc_object_t *obj )
468 vlc_mutex_lock( &obj->object_lock );
471 void __vlc_object_unlock( vlc_object_t *obj )
473 vlc_assert_locked( &obj->object_lock );
474 vlc_mutex_unlock( &obj->object_lock );
478 # include <winsock2.h>
479 # include <ws2tcpip.h>
482 * select()-able pipes emulated using Winsock
484 static int pipe (int fd[2])
487 int addrlen = sizeof (addr);
489 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
490 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
491 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
494 memset (&addr, 0, sizeof (addr));
495 addr.sin_family = AF_INET;
496 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
497 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
498 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
500 || connect (c, (PSOCKADDR)&addr, addrlen))
503 a = accept (l, NULL, NULL);
504 if (a == INVALID_SOCKET)
515 if (l != INVALID_SOCKET)
517 if (c != INVALID_SOCKET)
523 #define read( a, b, c ) recv (a, b, c, 0)
525 #define write( a, b, c ) send (a, b, c, 0)
527 #define close( a ) closesocket (a)
531 * Returns the readable end of a pipe that becomes readable once termination
532 * of the object is requested (vlc_object_kill()).
533 * This can be used to wake-up out of a select() or poll() event loop, such
534 * typically when doing network I/O.
536 * Note that the pipe will remain the same for the lifetime of the object.
537 * DO NOT read the pipe nor close it yourself. Ever.
539 * @param obj object that would be "killed"
540 * @return a readable pipe descriptor, or -1 on error.
542 int __vlc_object_waitpipe( vlc_object_t *obj )
544 int pfd[2] = { -1, -1 };
545 struct vlc_object_internals_t *internals = obj->p_internals;
546 vlc_bool_t killed = VLC_FALSE;
548 vlc_spin_lock (&internals->spin);
549 if (internals->pipes[0] == -1)
551 /* This can only ever happen if someone killed us without locking: */
552 assert (internals->pipes[1] == -1);
553 vlc_spin_unlock (&internals->spin);
558 vlc_spin_lock (&internals->spin);
559 if (internals->pipes[0] == -1)
561 internals->pipes[0] = pfd[0];
562 internals->pipes[1] = pfd[1];
563 pfd[0] = pfd[1] = -1;
567 vlc_spin_unlock (&internals->spin);
571 /* Race condition: vlc_object_kill() already invoked! */
574 vlc_spin_lock (&internals->spin);
575 fd = internals->pipes[1];
576 internals->pipes[1] = -1;
577 vlc_spin_unlock (&internals->spin);
579 msg_Dbg (obj, "waitpipe: object already dying");
584 /* Race condition: two threads call pipe() - unlikely */
590 return internals->pipes[0];
595 * Waits for the object to be signaled (using vlc_object_signal()).
596 * If the object already has a signal pending, this function will return
597 * immediately. It is asserted that the caller holds the object lock.
599 * @return true if the object is dying and should terminate.
601 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
603 vlc_assert_locked( &obj->object_lock );
604 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
610 * Waits for the object to be signaled (using vlc_object_signal()), or for
612 * If the object already has a signal pending, this function will return
613 * immediately. It is asserted that the caller holds the object lock.
615 * @return negative if the object is dying and should terminate,
616 * positive if the the object has been signaled but is not dying,
617 * 0 if timeout has been reached.
619 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
623 vlc_assert_locked( &obj->object_lock );
624 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
625 if( v == 0 ) /* signaled */
626 return obj->b_die ? -1 : 1;
632 * Checks whether an object has been "killed".
633 * The object lock must be held.
635 * Typical code for an object thread could be:
637 vlc_object_lock (self);
639 while (vlc_object_alive (self))
643 if (vlc_object_wait (self))
648 ...deinitialization...
649 vlc_object_unlock (self);
652 * @return true iff the object has not been killed yet
654 vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
656 vlc_assert_locked( &obj->object_lock );
662 * Signals an object for which the lock is held.
664 void __vlc_object_signal_unlocked( vlc_object_t *obj )
666 vlc_assert_locked (&obj->object_lock);
667 vlc_cond_signal( &obj->object_wait );
672 * Requests termination of an object.
673 * If the object is LibVLC, also request to terminate all its children.
675 void __vlc_object_kill( vlc_object_t *p_this )
677 struct vlc_object_internals_t *internals = p_this->p_internals;
680 vlc_mutex_lock( &p_this->object_lock );
681 p_this->b_die = VLC_TRUE;
683 vlc_spin_lock (&internals->spin);
684 fd = internals->pipes[1];
685 internals->pipes[1] = -1;
686 vlc_spin_unlock (&internals->spin);
690 msg_Dbg (p_this, "waitpipe: object killed");
694 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
695 for( int i = 0; i < p_this->i_children ; i++ )
696 vlc_object_kill( p_this->pp_children[i] );
698 vlc_object_signal_unlocked( p_this );
699 vlc_mutex_unlock( &p_this->object_lock );
704 * find an object given its ID
706 * This function looks for the object whose i_object_id field is i_id. We
707 * use a dichotomy so that lookups are in log2(n).
708 *****************************************************************************/
709 void * vlc_object_get( int i_id )
712 vlc_object_t **pp_objects;
713 libvlc_global_data_t *p_libvlc_global = vlc_global();
715 vlc_mutex_lock( &structure_lock );
717 pp_objects = p_libvlc_global->pp_objects;
719 /* Perform our dichotomy */
720 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
722 i_middle = i_max / 2;
724 if( pp_objects[i_middle]->i_object_id > i_id )
728 else if( pp_objects[i_middle]->i_object_id < i_id )
732 pp_objects += i_middle;
737 /* This happens when there are only two remaining objects */
738 if( pp_objects[i_middle+1]->i_object_id == i_id )
740 vlc_object_yield_locked( pp_objects[i_middle+1] );
741 vlc_mutex_unlock( &structure_lock );
742 return pp_objects[i_middle+1];
749 vlc_object_yield_locked( pp_objects[i_middle] );
750 vlc_mutex_unlock( &structure_lock );
751 return pp_objects[i_middle];
756 /* this means that i_max == i_middle, and since we have already
757 * tested pp_objects[i_middle]), p_found is properly set. */
762 vlc_mutex_unlock( &structure_lock );
767 ****************************************************************************
768 * find a typed object and increment its refcount
769 *****************************************************************************
770 * This function recursively looks for a given object type. i_mode can be one
771 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
772 *****************************************************************************/
773 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
775 vlc_object_t *p_found;
777 vlc_mutex_lock( &structure_lock );
779 /* Avoid obvious freed object uses */
780 assert( p_this->p_internals->i_refcount > 0 );
782 /* If we are of the requested type ourselves, don't look further */
783 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
785 vlc_object_yield_locked( p_this );
786 vlc_mutex_unlock( &structure_lock );
790 /* Otherwise, recursively look for the object */
791 if( (i_mode & 0x000f) == FIND_ANYWHERE )
793 vlc_object_t *p_root = p_this;
796 while( p_root->p_parent != NULL &&
797 p_root != VLC_OBJECT( p_this->p_libvlc ) )
799 p_root = p_root->p_parent;
802 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
803 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
805 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
806 i_type, (i_mode & ~0x000f)|FIND_CHILD );
811 p_found = FindObject( p_this, i_type, i_mode );
814 vlc_mutex_unlock( &structure_lock );
820 ****************************************************************************
821 * find a named object and increment its refcount
822 *****************************************************************************
823 * This function recursively looks for a given object name. i_mode can be one
824 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
825 *****************************************************************************/
826 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
829 vlc_object_t *p_found;
831 vlc_mutex_lock( &structure_lock );
833 /* Avoid obvious freed object uses */
834 assert( p_this->p_internals->i_refcount > 0 );
836 /* If have the requested name ourselves, don't look further */
837 if( !(i_mode & FIND_STRICT)
838 && p_this->psz_object_name
839 && !strcmp( p_this->psz_object_name, psz_name ) )
841 vlc_object_yield_locked( p_this );
842 vlc_mutex_unlock( &structure_lock );
846 /* Otherwise, recursively look for the object */
847 if( (i_mode & 0x000f) == FIND_ANYWHERE )
849 vlc_object_t *p_root = p_this;
852 while( p_root->p_parent != NULL &&
853 p_root != VLC_OBJECT( p_this->p_libvlc ) )
855 p_root = p_root->p_parent;
858 p_found = FindObjectName( p_root, psz_name,
859 (i_mode & ~0x000f)|FIND_CHILD );
860 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
862 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
863 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
868 p_found = FindObjectName( p_this, psz_name, i_mode );
871 vlc_mutex_unlock( &structure_lock );
877 ****************************************************************************
878 * increment an object refcount
879 *****************************************************************************/
881 /* When the structure_lock is locked */
882 static void vlc_object_yield_locked( vlc_object_t *p_this )
884 /* Avoid obvious freed object uses */
885 assert( p_this->p_internals->i_refcount > 0 );
887 /* Increment the counter */
888 p_this->p_internals->i_refcount++;
891 /* Public function */
892 void __vlc_object_yield( vlc_object_t *p_this )
894 vlc_mutex_lock( &structure_lock );
895 vlc_object_yield_locked( p_this );
896 vlc_mutex_unlock( &structure_lock );
900 /*****************************************************************************
901 * decrement an object refcount
902 * And destroy the object if its refcount reach zero.
903 *****************************************************************************/
904 void __vlc_object_release( vlc_object_t *p_this )
906 vlc_bool_t b_should_destroy;
908 vlc_mutex_lock( &structure_lock );
910 assert( p_this->p_internals->i_refcount > 0 );
911 p_this->p_internals->i_refcount--;
912 b_should_destroy = (p_this->p_internals->i_refcount == 0);
914 if( b_should_destroy )
916 /* Make sure this object can't be obtained via vlc_find_object now that
918 libvlc_global_data_t *p_libvlc_global = vlc_global();
921 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
922 * useless to try and recover anything if pp_objects gets smashed. */
923 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
924 p_libvlc_global->i_objects );
925 REMOVE_ELEM( p_libvlc_global->pp_objects,
926 p_libvlc_global->i_objects, i_index );
929 vlc_mutex_unlock( &structure_lock );
931 if( b_should_destroy )
932 vlc_object_destroy( p_this );
936 ****************************************************************************
937 * attach object to a parent object
938 *****************************************************************************
939 * This function sets p_this as a child of p_parent, and p_parent as a parent
940 * of p_this. This link can be undone using vlc_object_detach.
941 *****************************************************************************/
942 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
944 if( !p_this ) return;
946 vlc_mutex_lock( &structure_lock );
948 /* Avoid obvious freed object uses */
949 assert( p_this->p_internals->i_refcount > 0 );
951 /* Attach the parent to its child */
952 p_this->p_parent = p_parent;
954 /* Attach the child to its parent */
955 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
956 p_parent->i_children, p_this );
958 /* Climb up the tree to see whether we are connected with the root */
959 if( p_parent->p_internals->b_attached )
961 SetAttachment( p_this, VLC_TRUE );
964 vlc_mutex_unlock( &structure_lock );
968 ****************************************************************************
969 * detach object from its parent
970 *****************************************************************************
971 * This function removes all links between an object and its parent.
972 *****************************************************************************/
973 void __vlc_object_detach( vlc_object_t *p_this )
975 if( !p_this ) return;
977 vlc_mutex_lock( &structure_lock );
979 /* Avoid obvious freed object uses */
980 assert( p_this->p_internals->i_refcount > 0 );
982 if( !p_this->p_parent )
984 msg_Err( p_this, "object is not attached" );
985 vlc_mutex_unlock( &structure_lock );
989 /* Climb up the tree to see whether we are connected with the root */
990 if( p_this->p_parent->p_internals->b_attached )
992 SetAttachment( p_this, VLC_FALSE );
995 DetachObject( p_this );
996 vlc_mutex_unlock( &structure_lock );
1001 ****************************************************************************
1002 * find a list typed objects and increment their refcount
1003 *****************************************************************************
1004 * This function recursively looks for a given object type. i_mode can be one
1005 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
1006 *****************************************************************************/
1007 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
1010 vlc_object_t **pp_current, **pp_end;
1011 int i_count = 0, i_index = 0;
1012 libvlc_global_data_t *p_libvlc_global = vlc_global();
1014 vlc_mutex_lock( &structure_lock );
1016 /* Avoid obvious freed object uses */
1017 assert( p_this->p_internals->i_refcount > 0 );
1019 /* Look for the objects */
1020 switch( i_mode & 0x000f )
1023 pp_current = p_libvlc_global->pp_objects;
1024 pp_end = pp_current + p_libvlc_global->i_objects;
1026 for( ; pp_current < pp_end ; pp_current++ )
1028 if( (*pp_current)->p_internals->b_attached
1029 && (*pp_current)->i_object_type == i_type )
1035 p_list = NewList( i_count );
1036 pp_current = p_libvlc_global->pp_objects;
1038 for( ; pp_current < pp_end ; pp_current++ )
1040 if( (*pp_current)->p_internals->b_attached
1041 && (*pp_current)->i_object_type == i_type )
1043 ListReplace( p_list, *pp_current, i_index );
1044 if( i_index < i_count ) i_index++;
1050 i_count = CountChildren( p_this, i_type );
1051 p_list = NewList( i_count );
1053 /* Check allocation was successful */
1054 if( p_list->i_count != i_count )
1056 msg_Err( p_this, "list allocation failed!" );
1057 p_list->i_count = 0;
1061 p_list->i_count = 0;
1062 ListChildren( p_list, p_this, i_type );
1066 msg_Err( p_this, "unimplemented!" );
1067 p_list = NewList( 0 );
1071 vlc_mutex_unlock( &structure_lock );
1076 /*****************************************************************************
1077 * DumpCommand: print the current vlc structure
1078 *****************************************************************************
1079 * This function prints either an ASCII tree showing the connections between
1080 * vlc objects, and additional information such as their refcount, thread ID,
1081 * etc. (command "tree"), or the same data as a simple list (command "list").
1082 *****************************************************************************/
1083 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1084 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1086 libvlc_global_data_t *p_libvlc_global = vlc_global();
1088 (void)oldval; (void)p_data;
1089 if( *psz_cmd == 'l' )
1091 vlc_mutex_lock( &structure_lock );
1093 vlc_object_t **pp_current, **pp_end;
1095 pp_current = p_libvlc_global->pp_objects;
1096 pp_end = pp_current + p_libvlc_global->i_objects;
1098 for( ; pp_current < pp_end ; pp_current++ )
1100 if( (*pp_current)->p_internals->b_attached )
1102 PrintObject( *pp_current, "" );
1106 printf( " o %.8i %s (not attached)\n",
1107 (*pp_current)->i_object_id,
1108 (*pp_current)->psz_object_type );
1112 vlc_mutex_unlock( &structure_lock );
1116 vlc_object_t *p_object = NULL;
1118 if( *newval.psz_string )
1121 int i_id = strtol( newval.psz_string, &end, 0 );
1122 if( end != newval.psz_string )
1123 p_object = vlc_object_get( i_id );
1126 /* try using the object's name to find it */
1127 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1130 /* Look in p_libvlc's children tree */
1131 p_object = vlc_object_find_name( p_libvlc,
1134 vlc_object_release( p_libvlc );
1138 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1139 p_object = vlc_object_find_name( p_this,
1151 vlc_mutex_lock( &structure_lock );
1153 if( *psz_cmd == 't' )
1155 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1158 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1161 DumpStructure( p_object, 0, psz_foo );
1163 else if( *psz_cmd == 'v' )
1168 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1170 PrintObject( p_object, "" );
1172 if( !p_object->p_internals->i_vars )
1173 printf( " `-o No variables\n" );
1174 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1176 variable_t *p_var = p_object->p_internals->p_vars + i;
1178 const char *psz_type = "unknown";
1179 switch( p_var->i_type & VLC_VAR_TYPE )
1181 #define MYCASE( type, nice ) \
1182 case VLC_VAR_ ## type: \
1185 MYCASE( VOID, "void" );
1186 MYCASE( BOOL, "bool" );
1187 MYCASE( INTEGER, "integer" );
1188 MYCASE( HOTKEY, "hotkey" );
1189 MYCASE( STRING, "string" );
1190 MYCASE( MODULE, "module" );
1191 MYCASE( FILE, "file" );
1192 MYCASE( DIRECTORY, "directory" );
1193 MYCASE( VARIABLE, "variable" );
1194 MYCASE( FLOAT, "float" );
1195 MYCASE( TIME, "time" );
1196 MYCASE( ADDRESS, "address" );
1197 MYCASE( MUTEX, "mutex" );
1198 MYCASE( LIST, "list" );
1201 printf( " %c-o \"%s\" (%s",
1202 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1203 p_var->psz_name, psz_type );
1204 if( p_var->psz_text )
1205 printf( ", %s", p_var->psz_text );
1207 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1208 printf( ", command" );
1209 if( p_var->i_entries )
1210 printf( ", %d callbacks", p_var->i_entries );
1211 switch( p_var->i_type & 0x00f0 )
1217 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1219 case VLC_VAR_INTEGER:
1220 printf( ": %d", p_var->val.i_int );
1222 case VLC_VAR_STRING:
1223 printf( ": \"%s\"", p_var->val.psz_string );
1226 printf( ": %f", p_var->val.f_float );
1229 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1231 case VLC_VAR_ADDRESS:
1232 printf( ": %p", p_var->val.p_address );
1242 vlc_mutex_unlock( &structure_lock );
1244 if( *newval.psz_string )
1246 vlc_object_release( p_object );
1253 /*****************************************************************************
1254 * vlc_list_release: free a list previously allocated by vlc_list_find
1255 *****************************************************************************
1256 * This function decreases the refcount of all objects in the list and
1258 *****************************************************************************/
1259 void vlc_list_release( vlc_list_t *p_list )
1263 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1265 vlc_object_release( p_list->p_values[i_index].p_object );
1268 free( p_list->p_values );
1272 /* Following functions are local */
1274 /*****************************************************************************
1275 * FindIndex: find the index of an object in an array of objects
1276 *****************************************************************************
1277 * This function assumes that p_this can be found in pp_objects. It will not
1278 * crash if p_this cannot be found, but will return a wrong value. It is your
1279 * duty to check the return value if you are not certain that the object could
1280 * be found for sure.
1281 *****************************************************************************/
1282 static int FindIndex( vlc_object_t *p_this,
1283 vlc_object_t **pp_objects, int i_count )
1285 int i_middle = i_count / 2;
1292 if( pp_objects[i_middle] == p_this )
1302 /* We take advantage of the sorted array */
1303 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1305 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1306 i_count - i_middle );
1310 return FindIndex( p_this, pp_objects, i_middle );
1314 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1317 vlc_object_t *p_tmp;
1319 switch( i_mode & 0x000f )
1322 p_tmp = p_this->p_parent;
1325 if( p_tmp->i_object_type == i_type )
1327 vlc_object_yield_locked( p_tmp );
1332 return FindObject( p_tmp, i_type, i_mode );
1338 for( i = p_this->i_children; i--; )
1340 p_tmp = p_this->pp_children[i];
1341 if( p_tmp->i_object_type == i_type )
1343 vlc_object_yield_locked( p_tmp );
1346 else if( p_tmp->i_children )
1348 p_tmp = FindObject( p_tmp, i_type, i_mode );
1358 /* Handled in vlc_object_find */
1365 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1366 const char *psz_name,
1370 vlc_object_t *p_tmp;
1372 switch( i_mode & 0x000f )
1375 p_tmp = p_this->p_parent;
1378 if( p_tmp->psz_object_name
1379 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1381 vlc_object_yield_locked( p_tmp );
1386 return FindObjectName( p_tmp, psz_name, i_mode );
1392 for( i = p_this->i_children; i--; )
1394 p_tmp = p_this->pp_children[i];
1395 if( p_tmp->psz_object_name
1396 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1398 vlc_object_yield_locked( p_tmp );
1401 else if( p_tmp->i_children )
1403 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1413 /* Handled in vlc_object_find */
1420 static void DetachObject( vlc_object_t *p_this )
1422 vlc_object_t *p_parent = p_this->p_parent;
1425 /* Remove p_this's parent */
1426 p_this->p_parent = NULL;
1428 /* Remove all of p_parent's children which are p_this */
1429 for( i_index = p_parent->i_children ; i_index-- ; )
1431 if( p_parent->pp_children[i_index] == p_this )
1433 p_parent->i_children--;
1434 for( i = i_index ; i < p_parent->i_children ; i++ )
1436 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1441 if( p_parent->i_children )
1443 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1444 p_parent->i_children * sizeof(vlc_object_t *) );
1448 free( p_parent->pp_children );
1449 p_parent->pp_children = NULL;
1453 /*****************************************************************************
1454 * SetAttachment: recursively set the b_attached flag of a subtree.
1455 *****************************************************************************
1456 * This function is used by the attach and detach functions to propagate
1457 * the b_attached flag in a subtree.
1458 *****************************************************************************/
1459 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1463 for( i_index = p_this->i_children ; i_index-- ; )
1465 SetAttachment( p_this->pp_children[i_index], b_attached );
1468 p_this->p_internals->b_attached = b_attached;
1471 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1473 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1477 if( p_this->psz_object_name )
1479 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1481 psz_name[48] = '\"';
1484 psz_children[0] = '\0';
1485 switch( p_this->i_children )
1490 strcpy( psz_children, ", 1 child" );
1493 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1497 psz_refcount[0] = '\0';
1498 if( p_this->p_internals->i_refcount > 0 )
1499 snprintf( psz_refcount, 19, ", refcount %u",
1500 p_this->p_internals->i_refcount );
1502 psz_thread[0] = '\0';
1503 if( p_this->p_internals->b_thread )
1504 snprintf( psz_thread, 29, " (thread %u)",
1505 #if defined(WIN32) || defined(UNDER_CE)
1506 (unsigned)p_this->p_internals->thread_id.id );
1508 (unsigned)p_this->p_internals->thread_id );
1511 psz_parent[0] = '\0';
1512 if( p_this->p_parent )
1513 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1515 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1516 p_this->i_object_id, p_this->psz_object_type,
1517 psz_name, psz_thread, psz_refcount, psz_children,
1521 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1524 char i_back = psz_foo[i_level];
1525 psz_foo[i_level] = '\0';
1527 PrintObject( p_this, psz_foo );
1529 psz_foo[i_level] = i_back;
1531 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1533 msg_Warn( p_this, "structure tree is too deep" );
1537 for( i = 0 ; i < p_this->i_children ; i++ )
1541 psz_foo[i_level-1] = ' ';
1543 if( psz_foo[i_level-2] == '`' )
1545 psz_foo[i_level-2] = ' ';
1549 if( i == p_this->i_children - 1 )
1551 psz_foo[i_level] = '`';
1555 psz_foo[i_level] = '|';
1558 psz_foo[i_level+1] = '-';
1559 psz_foo[i_level+2] = '\0';
1561 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1565 static vlc_list_t * NewList( int i_count )
1567 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1568 if( p_list == NULL )
1573 p_list->i_count = i_count;
1577 p_list->p_values = NULL;
1581 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1582 if( p_list->p_values == NULL )
1584 p_list->i_count = 0;
1591 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1594 if( p_list == NULL || i_index >= p_list->i_count )
1599 vlc_object_yield_locked( p_object );
1601 p_list->p_values[i_index].p_object = p_object;
1606 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1608 if( p_list == NULL )
1613 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1614 * sizeof( vlc_value_t ) );
1615 if( p_list->p_values == NULL )
1617 p_list->i_count = 0;
1621 vlc_object_yield_locked( p_object );
1623 p_list->p_values[p_list->i_count].p_object = p_object;
1629 static int CountChildren( vlc_object_t *p_this, int i_type )
1631 vlc_object_t *p_tmp;
1634 for( i = 0; i < p_this->i_children; i++ )
1636 p_tmp = p_this->pp_children[i];
1638 if( p_tmp->i_object_type == i_type )
1643 if( p_tmp->i_children )
1645 i_count += CountChildren( p_tmp, i_type );
1652 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1654 vlc_object_t *p_tmp;
1657 for( i = 0; i < p_this->i_children; i++ )
1659 p_tmp = p_this->pp_children[i];
1661 if( p_tmp->i_object_type == i_type )
1663 ListReplace( p_list, p_tmp, p_list->i_count++ );
1666 if( p_tmp->i_children )
1668 ListChildren( p_list, p_tmp, i_type );