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";
340 i_size = i_type > (int)sizeof(vlc_object_t)
341 ? i_type : (int)sizeof(vlc_object_t);
342 i_type = VLC_OBJECT_GENERIC;
343 psz_type = "generic";
347 return vlc_custom_create( p_this, i_size, i_type, psz_type );
352 ****************************************************************************
353 * Destroy a vlc object (Internal)
355 * This function destroys an object that has been previously allocated with
356 * vlc_object_create. The object's refcount must be zero and it must not be
357 * attached to other objects in any way.
358 *****************************************************************************/
359 static void vlc_object_destroy( vlc_object_t *p_this )
361 vlc_object_internals_t *p_priv = vlc_internals( p_this );
364 if( p_this->i_children )
369 "ERROR: cannot delete object (%i, %s) with %d children\n",
370 p_this->i_object_id, p_this->psz_object_name,
371 p_this->i_children );
373 for( i = 0; i < p_this->i_children; i++ )
376 "ERROR: Remaining children object "
377 "(id:%i, type:%s, name:%s)\n",
378 p_this->pp_children[i]->i_object_id,
379 p_this->pp_children[i]->psz_object_type,
380 p_this->pp_children[i]->psz_object_name );
386 if( p_this->p_parent )
389 "ERROR: cannot delete object (id:%i, type:%s, name:%s) "
390 "with a parent (id:%i, type:%s, name:%s)\n",
391 p_this->i_object_id, p_this->psz_object_type,
392 p_this->psz_object_name, p_this->p_parent->i_object_id,
393 p_this->p_parent->psz_object_type,
394 p_this->p_parent->psz_object_name );
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 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;
416 if( p_global->i_objects > 0 )
419 for( i = 0; i < p_global->i_objects; i++ )
421 /* We are leaking this object */
423 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
424 p_global->pp_objects[i]->i_object_id,
425 p_global->pp_objects[i]->psz_object_type,
426 p_global->pp_objects[i]->psz_object_name );
429 /* Strongly abort, cause we want these to be fixed */
433 /* We are the global object ... no need to lock. */
434 free( p_global->pp_objects );
435 p_global->pp_objects = NULL;
437 vlc_mutex_destroy( &structure_lock );
440 #if defined(WIN32) || defined(UNDER_CE)
441 /* if object has an associated thread, close it now */
442 if( p_priv->thread_id.hThread )
443 CloseHandle(p_priv->thread_id.hThread);
446 vlc_mutex_destroy( &p_this->object_lock );
447 vlc_cond_destroy( &p_this->object_wait );
448 vlc_spin_destroy( &p_priv->spin );
449 if( p_priv->pipes[1] != -1 )
450 close( p_priv->pipes[1] );
451 if( p_priv->pipes[0] != -1 )
452 close( p_priv->pipes[0] );
454 /* global is not dynamically allocated by vlc_object_create */
455 if( p_this->i_object_type != VLC_OBJECT_GLOBAL )
460 /** Inter-object signaling */
462 void __vlc_object_lock( vlc_object_t *obj )
464 vlc_mutex_lock( &obj->object_lock );
467 void __vlc_object_unlock( vlc_object_t *obj )
469 vlc_assert_locked( &obj->object_lock );
470 vlc_mutex_unlock( &obj->object_lock );
474 # include <winsock2.h>
475 # include <ws2tcpip.h>
478 * select()-able pipes emulated using Winsock
480 static int pipe (int fd[2])
483 int addrlen = sizeof (addr);
485 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
486 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
487 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
490 memset (&addr, 0, sizeof (addr));
491 addr.sin_family = AF_INET;
492 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
493 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
494 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
496 || connect (c, (PSOCKADDR)&addr, addrlen))
499 a = accept (l, NULL, NULL);
500 if (a == INVALID_SOCKET)
511 if (l != INVALID_SOCKET)
513 if (c != INVALID_SOCKET)
519 #define read( a, b, c ) recv (a, b, c, 0)
521 #define write( a, b, c ) send (a, b, c, 0)
523 #define close( a ) closesocket (a)
527 * Returns the readable end of a pipe that becomes readable once termination
528 * of the object is requested (vlc_object_kill()).
529 * This can be used to wake-up out of a select() or poll() event loop, such
530 * typically when doing network I/O.
532 * Note that the pipe will remain the same for the lifetime of the object.
533 * DO NOT read the pipe nor close it yourself. Ever.
535 * @param obj object that would be "killed"
536 * @return a readable pipe descriptor, or -1 on error.
538 int __vlc_object_waitpipe( vlc_object_t *obj )
540 int pfd[2] = { -1, -1 };
541 struct vlc_object_internals_t *internals = obj->p_internals;
542 vlc_bool_t killed = VLC_FALSE;
544 vlc_spin_lock (&internals->spin);
545 if (internals->pipes[0] == -1)
547 /* This can only ever happen if someone killed us without locking: */
548 assert (internals->pipes[1] == -1);
549 vlc_spin_unlock (&internals->spin);
554 vlc_spin_lock (&internals->spin);
555 if (internals->pipes[0] == -1)
557 internals->pipes[0] = pfd[0];
558 internals->pipes[1] = pfd[1];
559 pfd[0] = pfd[1] = -1;
563 vlc_spin_unlock (&internals->spin);
567 /* Race condition: vlc_object_kill() already invoked! */
570 vlc_spin_lock (&internals->spin);
571 fd = internals->pipes[1];
572 internals->pipes[1] = -1;
573 vlc_spin_unlock (&internals->spin);
575 msg_Dbg (obj, "waitpipe: object already dying");
580 /* Race condition: two threads call pipe() - unlikely */
586 return internals->pipes[0];
591 * Waits for the object to be signaled (using vlc_object_signal()).
592 * If the object already has a signal pending, this function will return
593 * immediately. It is asserted that the caller holds the object lock.
595 * @return true if the object is dying and should terminate.
597 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
599 vlc_assert_locked( &obj->object_lock );
600 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
606 * Waits for the object to be signaled (using vlc_object_signal()), or for
608 * If the object already has a signal pending, this function will return
609 * immediately. It is asserted that the caller holds the object lock.
611 * @return negative if the object is dying and should terminate,
612 * positive if the the object has been signaled but is not dying,
613 * 0 if timeout has been reached.
615 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
619 vlc_assert_locked( &obj->object_lock );
620 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
621 if( v == 0 ) /* signaled */
622 return obj->b_die ? -1 : 1;
628 * Checks whether an object has been "killed".
629 * The object lock must be held.
631 * Typical code for an object thread could be:
633 vlc_object_lock (self);
635 while (vlc_object_alive (self))
639 if (vlc_object_wait (self))
644 ...deinitialization...
645 vlc_object_unlock (self);
648 * @return true iff the object has not been killed yet
650 vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
652 vlc_assert_locked( &obj->object_lock );
658 * Signals an object for which the lock is held.
660 void __vlc_object_signal_unlocked( vlc_object_t *obj )
662 vlc_assert_locked (&obj->object_lock);
663 vlc_cond_signal( &obj->object_wait );
668 * Requests termination of an object.
669 * If the object is LibVLC, also request to terminate all its children.
671 void __vlc_object_kill( vlc_object_t *p_this )
673 struct vlc_object_internals_t *internals = p_this->p_internals;
676 vlc_mutex_lock( &p_this->object_lock );
677 p_this->b_die = VLC_TRUE;
679 vlc_spin_lock (&internals->spin);
680 fd = internals->pipes[1];
681 internals->pipes[1] = -1;
682 vlc_spin_unlock (&internals->spin);
686 msg_Dbg (p_this, "waitpipe: object killed");
690 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
691 for( int i = 0; i < p_this->i_children ; i++ )
692 vlc_object_kill( p_this->pp_children[i] );
694 vlc_object_signal_unlocked( p_this );
695 vlc_mutex_unlock( &p_this->object_lock );
700 * find an object given its ID
702 * This function looks for the object whose i_object_id field is i_id. We
703 * use a dichotomy so that lookups are in log2(n).
704 *****************************************************************************/
705 void * vlc_object_get( int i_id )
708 vlc_object_t **pp_objects;
709 libvlc_global_data_t *p_libvlc_global = vlc_global();
711 vlc_mutex_lock( &structure_lock );
713 pp_objects = p_libvlc_global->pp_objects;
715 /* Perform our dichotomy */
716 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
718 i_middle = i_max / 2;
720 if( pp_objects[i_middle]->i_object_id > i_id )
724 else if( pp_objects[i_middle]->i_object_id < i_id )
728 pp_objects += i_middle;
733 /* This happens when there are only two remaining objects */
734 if( pp_objects[i_middle+1]->i_object_id == i_id )
736 vlc_object_yield_locked( pp_objects[i_middle+1] );
737 vlc_mutex_unlock( &structure_lock );
738 return pp_objects[i_middle+1];
745 vlc_object_yield_locked( pp_objects[i_middle] );
746 vlc_mutex_unlock( &structure_lock );
747 return pp_objects[i_middle];
752 /* this means that i_max == i_middle, and since we have already
753 * tested pp_objects[i_middle]), p_found is properly set. */
758 vlc_mutex_unlock( &structure_lock );
763 ****************************************************************************
764 * find a typed object and increment its refcount
765 *****************************************************************************
766 * This function recursively looks for a given object type. i_mode can be one
767 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
768 *****************************************************************************/
769 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
771 vlc_object_t *p_found;
773 vlc_mutex_lock( &structure_lock );
775 /* Avoid obvious freed object uses */
776 assert( p_this->p_internals->i_refcount > 0 );
778 /* If we are of the requested type ourselves, don't look further */
779 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
781 vlc_object_yield_locked( p_this );
782 vlc_mutex_unlock( &structure_lock );
786 /* Otherwise, recursively look for the object */
787 if( (i_mode & 0x000f) == FIND_ANYWHERE )
789 vlc_object_t *p_root = p_this;
792 while( p_root->p_parent != NULL &&
793 p_root != VLC_OBJECT( p_this->p_libvlc ) )
795 p_root = p_root->p_parent;
798 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
799 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
801 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
802 i_type, (i_mode & ~0x000f)|FIND_CHILD );
807 p_found = FindObject( p_this, i_type, i_mode );
810 vlc_mutex_unlock( &structure_lock );
816 ****************************************************************************
817 * find a named object and increment its refcount
818 *****************************************************************************
819 * This function recursively looks for a given object name. i_mode can be one
820 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
821 *****************************************************************************/
822 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
825 vlc_object_t *p_found;
827 vlc_mutex_lock( &structure_lock );
829 /* Avoid obvious freed object uses */
830 assert( p_this->p_internals->i_refcount > 0 );
832 /* If have the requested name ourselves, don't look further */
833 if( !(i_mode & FIND_STRICT)
834 && p_this->psz_object_name
835 && !strcmp( p_this->psz_object_name, psz_name ) )
837 vlc_object_yield_locked( p_this );
838 vlc_mutex_unlock( &structure_lock );
842 /* Otherwise, recursively look for the object */
843 if( (i_mode & 0x000f) == FIND_ANYWHERE )
845 vlc_object_t *p_root = p_this;
848 while( p_root->p_parent != NULL &&
849 p_root != VLC_OBJECT( p_this->p_libvlc ) )
851 p_root = p_root->p_parent;
854 p_found = FindObjectName( p_root, psz_name,
855 (i_mode & ~0x000f)|FIND_CHILD );
856 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
858 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
859 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
864 p_found = FindObjectName( p_this, psz_name, i_mode );
867 vlc_mutex_unlock( &structure_lock );
873 ****************************************************************************
874 * increment an object refcount
875 *****************************************************************************/
877 /* When the structure_lock is locked */
878 static void vlc_object_yield_locked( vlc_object_t *p_this )
880 /* Avoid obvious freed object uses */
881 assert( p_this->p_internals->i_refcount > 0 );
883 /* Increment the counter */
884 p_this->p_internals->i_refcount++;
887 /* Public function */
888 void __vlc_object_yield( vlc_object_t *p_this )
890 vlc_mutex_lock( &structure_lock );
891 vlc_object_yield_locked( p_this );
892 vlc_mutex_unlock( &structure_lock );
896 /*****************************************************************************
897 * decrement an object refcount
898 * And destroy the object if its refcount reach zero.
899 *****************************************************************************/
900 void __vlc_object_release( vlc_object_t *p_this )
902 vlc_bool_t b_should_destroy;
904 vlc_mutex_lock( &structure_lock );
906 assert( p_this->p_internals->i_refcount > 0 );
907 p_this->p_internals->i_refcount--;
908 b_should_destroy = (p_this->p_internals->i_refcount == 0);
910 if( b_should_destroy )
912 /* Make sure this object can't be obtained via vlc_find_object now that
914 libvlc_global_data_t *p_libvlc_global = vlc_global();
917 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
918 * useless to try and recover anything if pp_objects gets smashed. */
919 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
920 p_libvlc_global->i_objects );
921 REMOVE_ELEM( p_libvlc_global->pp_objects,
922 p_libvlc_global->i_objects, i_index );
925 vlc_mutex_unlock( &structure_lock );
927 if( b_should_destroy )
928 vlc_object_destroy( p_this );
932 ****************************************************************************
933 * attach object to a parent object
934 *****************************************************************************
935 * This function sets p_this as a child of p_parent, and p_parent as a parent
936 * of p_this. This link can be undone using vlc_object_detach.
937 *****************************************************************************/
938 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
940 if( !p_this ) return;
942 vlc_mutex_lock( &structure_lock );
944 /* Avoid obvious freed object uses */
945 assert( p_this->p_internals->i_refcount > 0 );
947 /* Attach the parent to its child */
948 p_this->p_parent = p_parent;
950 /* Attach the child to its parent */
951 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
952 p_parent->i_children, p_this );
954 /* Climb up the tree to see whether we are connected with the root */
955 if( p_parent->p_internals->b_attached )
957 SetAttachment( p_this, VLC_TRUE );
960 vlc_mutex_unlock( &structure_lock );
964 ****************************************************************************
965 * detach object from its parent
966 *****************************************************************************
967 * This function removes all links between an object and its parent.
968 *****************************************************************************/
969 void __vlc_object_detach( vlc_object_t *p_this )
971 if( !p_this ) return;
973 vlc_mutex_lock( &structure_lock );
975 /* Avoid obvious freed object uses */
976 assert( p_this->p_internals->i_refcount > 0 );
978 if( !p_this->p_parent )
980 msg_Err( p_this, "object is not attached" );
981 vlc_mutex_unlock( &structure_lock );
985 /* Climb up the tree to see whether we are connected with the root */
986 if( p_this->p_parent->p_internals->b_attached )
988 SetAttachment( p_this, VLC_FALSE );
991 DetachObject( p_this );
992 vlc_mutex_unlock( &structure_lock );
997 ****************************************************************************
998 * find a list typed objects and increment their refcount
999 *****************************************************************************
1000 * This function recursively looks for a given object type. i_mode can be one
1001 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
1002 *****************************************************************************/
1003 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
1006 vlc_object_t **pp_current, **pp_end;
1007 int i_count = 0, i_index = 0;
1008 libvlc_global_data_t *p_libvlc_global = vlc_global();
1010 vlc_mutex_lock( &structure_lock );
1012 /* Avoid obvious freed object uses */
1013 assert( p_this->p_internals->i_refcount > 0 );
1015 /* Look for the objects */
1016 switch( i_mode & 0x000f )
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
1025 && (*pp_current)->i_object_type == i_type )
1031 p_list = NewList( i_count );
1032 pp_current = p_libvlc_global->pp_objects;
1034 for( ; pp_current < pp_end ; pp_current++ )
1036 if( (*pp_current)->p_internals->b_attached
1037 && (*pp_current)->i_object_type == i_type )
1039 ListReplace( p_list, *pp_current, i_index );
1040 if( i_index < i_count ) i_index++;
1046 i_count = CountChildren( p_this, i_type );
1047 p_list = NewList( i_count );
1049 /* Check allocation was successful */
1050 if( p_list->i_count != i_count )
1052 msg_Err( p_this, "list allocation failed!" );
1053 p_list->i_count = 0;
1057 p_list->i_count = 0;
1058 ListChildren( p_list, p_this, i_type );
1062 msg_Err( p_this, "unimplemented!" );
1063 p_list = NewList( 0 );
1067 vlc_mutex_unlock( &structure_lock );
1072 /*****************************************************************************
1073 * DumpCommand: print the current vlc structure
1074 *****************************************************************************
1075 * This function prints either an ASCII tree showing the connections between
1076 * vlc objects, and additional information such as their refcount, thread ID,
1077 * etc. (command "tree"), or the same data as a simple list (command "list").
1078 *****************************************************************************/
1079 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1080 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1082 libvlc_global_data_t *p_libvlc_global = vlc_global();
1084 (void)oldval; (void)p_data;
1085 if( *psz_cmd == 'l' )
1087 vlc_mutex_lock( &structure_lock );
1089 vlc_object_t **pp_current, **pp_end;
1091 pp_current = p_libvlc_global->pp_objects;
1092 pp_end = pp_current + p_libvlc_global->i_objects;
1094 for( ; pp_current < pp_end ; pp_current++ )
1096 if( (*pp_current)->p_internals->b_attached )
1098 PrintObject( *pp_current, "" );
1102 printf( " o %.8i %s (not attached)\n",
1103 (*pp_current)->i_object_id,
1104 (*pp_current)->psz_object_type );
1108 vlc_mutex_unlock( &structure_lock );
1112 vlc_object_t *p_object = NULL;
1114 if( *newval.psz_string )
1117 int i_id = strtol( newval.psz_string, &end, 0 );
1118 if( end != newval.psz_string )
1119 p_object = vlc_object_get( i_id );
1122 /* try using the object's name to find it */
1123 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1126 /* Look in p_libvlc's children tree */
1127 p_object = vlc_object_find_name( p_libvlc,
1130 vlc_object_release( p_libvlc );
1134 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1135 p_object = vlc_object_find_name( p_this,
1147 vlc_mutex_lock( &structure_lock );
1149 if( *psz_cmd == 't' )
1151 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1154 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1157 DumpStructure( p_object, 0, psz_foo );
1159 else if( *psz_cmd == 'v' )
1164 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1166 PrintObject( p_object, "" );
1168 if( !p_object->p_internals->i_vars )
1169 printf( " `-o No variables\n" );
1170 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1172 variable_t *p_var = p_object->p_internals->p_vars + i;
1174 const char *psz_type = "unknown";
1175 switch( p_var->i_type & VLC_VAR_TYPE )
1177 #define MYCASE( type, nice ) \
1178 case VLC_VAR_ ## type: \
1181 MYCASE( VOID, "void" );
1182 MYCASE( BOOL, "bool" );
1183 MYCASE( INTEGER, "integer" );
1184 MYCASE( HOTKEY, "hotkey" );
1185 MYCASE( STRING, "string" );
1186 MYCASE( MODULE, "module" );
1187 MYCASE( FILE, "file" );
1188 MYCASE( DIRECTORY, "directory" );
1189 MYCASE( VARIABLE, "variable" );
1190 MYCASE( FLOAT, "float" );
1191 MYCASE( TIME, "time" );
1192 MYCASE( ADDRESS, "address" );
1193 MYCASE( MUTEX, "mutex" );
1194 MYCASE( LIST, "list" );
1197 printf( " %c-o \"%s\" (%s",
1198 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1199 p_var->psz_name, psz_type );
1200 if( p_var->psz_text )
1201 printf( ", %s", p_var->psz_text );
1203 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1204 printf( ", command" );
1205 if( p_var->i_entries )
1206 printf( ", %d callbacks", p_var->i_entries );
1207 switch( p_var->i_type & 0x00f0 )
1213 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1215 case VLC_VAR_INTEGER:
1216 printf( ": %d", p_var->val.i_int );
1218 case VLC_VAR_STRING:
1219 printf( ": \"%s\"", p_var->val.psz_string );
1222 printf( ": %f", p_var->val.f_float );
1225 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1227 case VLC_VAR_ADDRESS:
1228 printf( ": %p", p_var->val.p_address );
1238 vlc_mutex_unlock( &structure_lock );
1240 if( *newval.psz_string )
1242 vlc_object_release( p_object );
1249 /*****************************************************************************
1250 * vlc_list_release: free a list previously allocated by vlc_list_find
1251 *****************************************************************************
1252 * This function decreases the refcount of all objects in the list and
1254 *****************************************************************************/
1255 void vlc_list_release( vlc_list_t *p_list )
1259 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1261 vlc_object_release( p_list->p_values[i_index].p_object );
1264 free( p_list->p_values );
1268 /* Following functions are local */
1270 /*****************************************************************************
1271 * FindIndex: find the index of an object in an array of objects
1272 *****************************************************************************
1273 * This function assumes that p_this can be found in pp_objects. It will not
1274 * crash if p_this cannot be found, but will return a wrong value. It is your
1275 * duty to check the return value if you are not certain that the object could
1276 * be found for sure.
1277 *****************************************************************************/
1278 static int FindIndex( vlc_object_t *p_this,
1279 vlc_object_t **pp_objects, int i_count )
1281 int i_middle = i_count / 2;
1288 if( pp_objects[i_middle] == p_this )
1298 /* We take advantage of the sorted array */
1299 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1301 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1302 i_count - i_middle );
1306 return FindIndex( p_this, pp_objects, i_middle );
1310 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1313 vlc_object_t *p_tmp;
1315 switch( i_mode & 0x000f )
1318 p_tmp = p_this->p_parent;
1321 if( p_tmp->i_object_type == i_type )
1323 vlc_object_yield_locked( p_tmp );
1328 return FindObject( p_tmp, i_type, i_mode );
1334 for( i = p_this->i_children; i--; )
1336 p_tmp = p_this->pp_children[i];
1337 if( p_tmp->i_object_type == i_type )
1339 vlc_object_yield_locked( p_tmp );
1342 else if( p_tmp->i_children )
1344 p_tmp = FindObject( p_tmp, i_type, i_mode );
1354 /* Handled in vlc_object_find */
1361 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1362 const char *psz_name,
1366 vlc_object_t *p_tmp;
1368 switch( i_mode & 0x000f )
1371 p_tmp = p_this->p_parent;
1374 if( p_tmp->psz_object_name
1375 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1377 vlc_object_yield_locked( p_tmp );
1382 return FindObjectName( p_tmp, psz_name, i_mode );
1388 for( i = p_this->i_children; i--; )
1390 p_tmp = p_this->pp_children[i];
1391 if( p_tmp->psz_object_name
1392 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1394 vlc_object_yield_locked( p_tmp );
1397 else if( p_tmp->i_children )
1399 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1409 /* Handled in vlc_object_find */
1416 static void DetachObject( vlc_object_t *p_this )
1418 vlc_object_t *p_parent = p_this->p_parent;
1421 /* Remove p_this's parent */
1422 p_this->p_parent = NULL;
1424 /* Remove all of p_parent's children which are p_this */
1425 for( i_index = p_parent->i_children ; i_index-- ; )
1427 if( p_parent->pp_children[i_index] == p_this )
1429 p_parent->i_children--;
1430 for( i = i_index ; i < p_parent->i_children ; i++ )
1432 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1437 if( p_parent->i_children )
1439 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1440 p_parent->i_children * sizeof(vlc_object_t *) );
1444 free( p_parent->pp_children );
1445 p_parent->pp_children = NULL;
1449 /*****************************************************************************
1450 * SetAttachment: recursively set the b_attached flag of a subtree.
1451 *****************************************************************************
1452 * This function is used by the attach and detach functions to propagate
1453 * the b_attached flag in a subtree.
1454 *****************************************************************************/
1455 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1459 for( i_index = p_this->i_children ; i_index-- ; )
1461 SetAttachment( p_this->pp_children[i_index], b_attached );
1464 p_this->p_internals->b_attached = b_attached;
1467 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1469 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1473 if( p_this->psz_object_name )
1475 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1477 psz_name[48] = '\"';
1480 psz_children[0] = '\0';
1481 switch( p_this->i_children )
1486 strcpy( psz_children, ", 1 child" );
1489 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1493 psz_refcount[0] = '\0';
1494 if( p_this->p_internals->i_refcount > 0 )
1495 snprintf( psz_refcount, 19, ", refcount %u",
1496 p_this->p_internals->i_refcount );
1498 psz_thread[0] = '\0';
1499 if( p_this->p_internals->b_thread )
1500 snprintf( psz_thread, 29, " (thread %u)",
1501 #if defined(WIN32) || defined(UNDER_CE)
1502 (unsigned)p_this->p_internals->thread_id.id );
1504 (unsigned)p_this->p_internals->thread_id );
1507 psz_parent[0] = '\0';
1508 if( p_this->p_parent )
1509 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1511 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1512 p_this->i_object_id, p_this->psz_object_type,
1513 psz_name, psz_thread, psz_refcount, psz_children,
1517 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1520 char i_back = psz_foo[i_level];
1521 psz_foo[i_level] = '\0';
1523 PrintObject( p_this, psz_foo );
1525 psz_foo[i_level] = i_back;
1527 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1529 msg_Warn( p_this, "structure tree is too deep" );
1533 for( i = 0 ; i < p_this->i_children ; i++ )
1537 psz_foo[i_level-1] = ' ';
1539 if( psz_foo[i_level-2] == '`' )
1541 psz_foo[i_level-2] = ' ';
1545 if( i == p_this->i_children - 1 )
1547 psz_foo[i_level] = '`';
1551 psz_foo[i_level] = '|';
1554 psz_foo[i_level+1] = '-';
1555 psz_foo[i_level+2] = '\0';
1557 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1561 static vlc_list_t * NewList( int i_count )
1563 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1564 if( p_list == NULL )
1569 p_list->i_count = i_count;
1573 p_list->p_values = NULL;
1577 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1578 if( p_list->p_values == NULL )
1580 p_list->i_count = 0;
1587 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1590 if( p_list == NULL || i_index >= p_list->i_count )
1595 vlc_object_yield_locked( p_object );
1597 p_list->p_values[i_index].p_object = p_object;
1602 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1604 if( p_list == NULL )
1609 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1610 * sizeof( vlc_value_t ) );
1611 if( p_list->p_values == NULL )
1613 p_list->i_count = 0;
1617 vlc_object_yield_locked( p_object );
1619 p_list->p_values[p_list->i_count].p_object = p_object;
1625 static int CountChildren( vlc_object_t *p_this, int i_type )
1627 vlc_object_t *p_tmp;
1630 for( i = 0; i < p_this->i_children; i++ )
1632 p_tmp = p_this->pp_children[i];
1634 if( p_tmp->i_object_type == i_type )
1639 if( p_tmp->i_children )
1641 i_count += CountChildren( p_tmp, i_type );
1648 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1650 vlc_object_t *p_tmp;
1653 for( i = 0; i < p_this->i_children; i++ )
1655 p_tmp = p_this->pp_children[i];
1657 if( p_tmp->i_object_type == i_type )
1659 ListReplace( p_list, p_tmp, p_list->i_count++ );
1662 if( p_tmp->i_children )
1664 ListChildren( p_list, p_tmp, i_type );