1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004-2008 the VideoLAN team
6 * Authors: Samuel Hocevar <sam@zoy.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
25 * This file contains the functions to handle the vlc_object_t type
27 * Unless otherwise stated, functions in this file are not cancellation point.
28 * All functions in this file are safe w.r.t. deferred cancellation.
32 /*****************************************************************************
34 *****************************************************************************/
39 #include <vlc_common.h>
41 #include "../libvlc.h"
44 #include "audio_output/aout_internal.h"
46 #include <vlc_access.h>
47 #include <vlc_demux.h>
48 #include <vlc_stream.h>
51 #include "stream_output/stream_output.h"
53 #include "vlc_interface.h"
54 #include "vlc_codec.h"
55 #include "vlc_filter.h"
57 #include "variables.h"
63 # include <errno.h> /* ENOSYS */
67 /*****************************************************************************
69 *****************************************************************************/
70 static int DumpCommand( vlc_object_t *, char const *,
71 vlc_value_t, vlc_value_t, void * );
73 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
74 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
75 static void PrintObject ( vlc_object_t *, const char * );
76 static void DumpStructure ( vlc_object_t *, int, char * );
78 static vlc_list_t * NewList ( int );
79 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
80 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
81 static int CountChildren ( vlc_object_t *, int );
82 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
84 static void vlc_object_destroy( vlc_object_t *p_this );
85 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
86 static void vlc_object_dump( vlc_object_t *p_this );
88 /*****************************************************************************
89 * Local structure lock
90 *****************************************************************************/
91 static vlc_mutex_t structure_lock;
93 static void close_nocancel (int fd)
95 int canc = vlc_savecancel ();
97 vlc_restorecancel (canc);
100 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
101 int i_type, const char *psz_type )
104 vlc_object_internals_t *p_priv;
107 * VLC objects are laid out as follow:
108 * - first the LibVLC-private per-object data,
109 * - then VLC_COMMON members from vlc_object_t,
110 * - finally, the type-specific data (if any).
112 * This function initializes the LibVLC and common data,
113 * and zeroes the rest.
115 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
119 assert (i_size >= sizeof (vlc_object_t));
120 p_new = (vlc_object_t *)(p_priv + 1);
122 p_new->i_object_type = i_type;
123 p_new->psz_object_type = psz_type;
124 p_new->psz_object_name = NULL;
126 p_new->b_die = false;
127 p_new->b_error = false;
128 p_new->b_force = false;
130 p_new->psz_header = NULL;
133 p_new->i_flags = p_this->i_flags
134 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
136 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
138 if( !p_priv->p_vars )
146 if( i_type == VLC_OBJECT_LIBVLC )
147 p_new->p_libvlc = (libvlc_int_t*)p_new;
150 p_new->p_libvlc = NULL;
151 vlc_mutex_init( &structure_lock );
154 p_this = p_priv->next = p_priv->prev = p_new;
157 p_new->p_libvlc = p_this->p_libvlc;
159 vlc_spin_init( &p_priv->ref_spin );
160 p_priv->i_refcount = 1;
161 p_priv->pf_destructor = NULL;
162 p_priv->b_thread = false;
163 p_new->p_parent = NULL;
164 p_priv->pp_children = NULL;
165 p_priv->i_children = 0;
167 p_new->p_private = NULL;
169 /* Initialize mutexes and condvars */
170 vlc_mutex_init( &p_priv->lock );
171 vlc_cond_init( &p_priv->wait );
172 vlc_mutex_init( &p_priv->var_lock );
173 vlc_spin_init( &p_priv->spin );
174 p_priv->pipes[0] = p_priv->pipes[1] = -1;
176 p_priv->next = p_this;
177 vlc_mutex_lock( &structure_lock );
178 p_priv->prev = vlc_internals (p_this)->prev;
179 vlc_internals (p_this)->prev = p_new;
180 vlc_internals (p_priv->prev)->next = p_new;
181 vlc_mutex_unlock( &structure_lock );
183 if( i_type == VLC_OBJECT_LIBVLC )
185 int canc = vlc_savecancel ();
186 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
187 var_AddCallback( p_new, "list", DumpCommand, NULL );
188 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
189 var_AddCallback( p_new, "tree", DumpCommand, NULL );
190 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
191 var_AddCallback( p_new, "vars", DumpCommand, NULL );
192 vlc_restorecancel (canc);
200 * Allocates and initializes a vlc object.
202 * @param i_type known object type (all of them are negative integer values),
203 * or object byte size (always positive).
205 * @return the new object, or NULL on error.
207 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
209 const char * psz_type;
214 case VLC_OBJECT_INTF:
215 i_size = sizeof(intf_thread_t);
216 psz_type = "interface";
218 case VLC_OBJECT_DECODER:
219 i_size = sizeof(decoder_t);
220 psz_type = "decoder";
222 case VLC_OBJECT_PACKETIZER:
223 i_size = sizeof(decoder_t);
224 psz_type = "packetizer";
226 case VLC_OBJECT_ENCODER:
227 i_size = sizeof(encoder_t);
228 psz_type = "encoder";
230 case VLC_OBJECT_AOUT:
231 i_size = sizeof(aout_instance_t);
232 psz_type = "audio output";
234 case VLC_OBJECT_OPENGL:
235 i_size = sizeof( vout_thread_t );
239 assert( i_type > 0 ); /* unknown type?! */
241 i_type = VLC_OBJECT_GENERIC;
242 psz_type = "generic";
246 return vlc_custom_create( p_this, i_size, i_type, psz_type );
251 ****************************************************************************
252 * Set the destructor of a vlc object
254 * This function sets the destructor of the vlc object. It will be called
255 * when the object is destroyed when the its refcount reaches 0.
256 * (It is called by the internal function vlc_object_destroy())
257 *****************************************************************************/
258 void __vlc_object_set_destructor( vlc_object_t *p_this,
259 vlc_destructor_t pf_destructor )
261 vlc_object_internals_t *p_priv = vlc_internals(p_this );
262 p_priv->pf_destructor = pf_destructor;
266 ****************************************************************************
267 * Destroy a vlc object (Internal)
269 * This function destroys an object that has been previously allocated with
270 * vlc_object_create. The object's refcount must be zero and it must not be
271 * attached to other objects in any way.
273 * This function must be called with cancellation disabled (currently).
274 *****************************************************************************/
275 static void vlc_object_destroy( vlc_object_t *p_this )
277 vlc_object_internals_t *p_priv = vlc_internals( p_this );
279 /* Objects are always detached beforehand */
280 assert( !p_this->p_parent );
282 /* Send a kill to the object's thread if applicable */
283 vlc_object_kill( p_this );
285 /* Call the custom "subclass" destructor */
286 if( p_priv->pf_destructor )
287 p_priv->pf_destructor( p_this );
289 /* Any thread must have been cleaned up at this point. */
290 assert( !p_priv->b_thread );
292 /* Destroy the associated variables, starting from the end so that
293 * no memmove calls have to be done. */
294 while( p_priv->i_vars )
296 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
299 free( p_priv->p_vars );
300 vlc_mutex_destroy( &p_priv->var_lock );
302 free( p_this->psz_header );
304 if( p_this->p_libvlc == NULL )
305 /* We are the global object ... no need to lock. */
306 vlc_mutex_destroy( &structure_lock );
308 FREENULL( p_this->psz_object_name );
310 vlc_spin_destroy( &p_priv->ref_spin );
311 vlc_mutex_destroy( &p_priv->lock );
312 vlc_cond_destroy( &p_priv->wait );
313 vlc_spin_destroy( &p_priv->spin );
314 if( p_priv->pipes[1] != -1 )
315 close( p_priv->pipes[1] );
316 if( p_priv->pipes[0] != -1 )
317 close( p_priv->pipes[0] );
323 /** Inter-object signaling */
325 void __vlc_object_lock( vlc_object_t *obj )
327 vlc_mutex_lock( &(vlc_internals(obj)->lock) );
330 void __vlc_object_unlock( vlc_object_t *obj )
332 vlc_assert_locked( &(vlc_internals(obj)->lock) );
333 vlc_mutex_unlock( &(vlc_internals(obj)->lock) );
337 # include <winsock2.h>
338 # include <ws2tcpip.h>
341 * select()-able pipes emulated using Winsock
343 static int pipe (int fd[2])
346 int addrlen = sizeof (addr);
348 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
349 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
350 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
353 memset (&addr, 0, sizeof (addr));
354 addr.sin_family = AF_INET;
355 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
356 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
357 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
359 || connect (c, (PSOCKADDR)&addr, addrlen))
362 a = accept (l, NULL, NULL);
363 if (a == INVALID_SOCKET)
374 if (l != INVALID_SOCKET)
376 if (c != INVALID_SOCKET)
382 #define read( a, b, c ) recv (a, b, c, 0)
384 #define write( a, b, c ) send (a, b, c, 0)
386 #define close( a ) closesocket (a)
390 * Returns the readable end of a pipe that becomes readable once termination
391 * of the object is requested (vlc_object_kill()).
392 * This can be used to wake-up out of a select() or poll() event loop, such
393 * typically when doing network I/O.
395 * Note that the pipe will remain the same for the lifetime of the object.
396 * DO NOT read the pipe nor close it yourself. Ever.
398 * @param obj object that would be "killed"
399 * @return a readable pipe descriptor, or -1 on error.
401 int __vlc_object_waitpipe( vlc_object_t *obj )
403 int pfd[2] = { -1, -1 };
404 vlc_object_internals_t *internals = vlc_internals( obj );
407 vlc_spin_lock (&internals->spin);
408 if (internals->pipes[0] == -1)
410 /* This can only ever happen if someone killed us without locking: */
411 assert (internals->pipes[1] == -1);
412 vlc_spin_unlock (&internals->spin);
417 vlc_spin_lock (&internals->spin);
418 if (internals->pipes[0] == -1)
420 internals->pipes[0] = pfd[0];
421 internals->pipes[1] = pfd[1];
422 pfd[0] = pfd[1] = -1;
426 vlc_spin_unlock (&internals->spin);
430 /* Race condition: vlc_object_kill() already invoked! */
433 vlc_spin_lock (&internals->spin);
434 fd = internals->pipes[1];
435 internals->pipes[1] = -1;
436 vlc_spin_unlock (&internals->spin);
438 msg_Dbg (obj, "waitpipe: object already dying");
443 /* Race condition: two threads call pipe() - unlikely */
449 return internals->pipes[0];
454 * Suspends until another thread calls vlc_object_signal_unlocked().
455 * The thread may be woken up earlier due to limitations of the underlying
458 * In new code, please use vlc_cond_wait() instead.
460 * This function is a cancellation point. In case of cancellation, the object
461 * will be in locked state.
463 void __vlc_object_wait( vlc_object_t *obj )
465 vlc_object_internals_t *priv = vlc_internals( obj );
466 vlc_assert_locked( &priv->lock);
467 vlc_cond_wait( &priv->wait, &priv->lock );
472 * Wakes up one thread waiting on the object. If no thread are (yet) waiting,
475 * Please do not use this function in new code as we are trying to untangle
476 * objects and threads. Use vlc_cond_wait() instead.
478 void __vlc_object_signal_unlocked( vlc_object_t *obj )
480 vlc_assert_locked (&(vlc_internals(obj)->lock));
481 vlc_cond_signal( &(vlc_internals(obj)->wait) );
486 * Requests termination of an object.
487 * If the object is LibVLC, also request to terminate all its children.
489 void __vlc_object_kill( vlc_object_t *p_this )
491 vlc_object_internals_t *priv = vlc_internals( p_this );
494 vlc_thread_cancel( p_this );
495 vlc_object_lock( p_this );
496 p_this->b_die = true;
498 vlc_spin_lock (&priv->spin);
501 vlc_spin_unlock (&priv->spin);
505 msg_Dbg (p_this, "waitpipe: object killed");
509 vlc_cond_broadcast (&priv->wait);
510 /* This also serves as a memory barrier toward vlc_object_alive(): */
511 vlc_object_unlock( p_this );
515 /*****************************************************************************
516 * find a typed object and increment its refcount
517 *****************************************************************************
518 * This function recursively looks for a given object type. i_mode can be one
519 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
520 *****************************************************************************/
521 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
523 vlc_object_t *p_found;
525 /* If we are of the requested type ourselves, don't look further */
526 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
528 vlc_object_yield( p_this );
532 /* Otherwise, recursively look for the object */
533 if ((i_mode & 0x000f) == FIND_ANYWHERE)
536 if (i_type == VLC_OBJECT_PLAYLIST)
537 msg_Err (p_this, "using vlc_object_find(VLC_OBJECT_PLAYLIST) "
538 "instead of pl_Yield()");
540 return vlc_object_find (p_this->p_libvlc, i_type,
541 (i_mode & ~0x000f)|FIND_CHILD);
544 vlc_mutex_lock( &structure_lock );
545 p_found = FindObject( p_this, i_type, i_mode );
546 vlc_mutex_unlock( &structure_lock );
550 #undef vlc_object_find_name
552 * Finds a named object and increment its reference count.
553 * Beware that objects found in this manner can be "owned" by another thread,
554 * be of _any_ type, and be attached to any module (if any). With such an
555 * object reference, you can set or get object variables, emit log messages,
556 * and read write-once object parameters (psz_object_type, etc).
557 * You CANNOT cast the object to a more specific object type, and you
558 * definitely cannot invoke object type-specific callbacks with this.
560 * @param p_this object to search from
561 * @param psz_name name of the object to search for
562 * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
564 * @return a matching object (must be released by the caller),
567 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
568 const char *psz_name, int i_mode )
570 vlc_object_t *p_found;
572 /* If have the requested name ourselves, don't look further */
573 if( !(i_mode & FIND_STRICT)
574 && p_this->psz_object_name
575 && !strcmp( p_this->psz_object_name, psz_name ) )
577 vlc_object_yield( p_this );
581 vlc_mutex_lock( &structure_lock );
583 /* Otherwise, recursively look for the object */
584 if( (i_mode & 0x000f) == FIND_ANYWHERE )
586 vlc_object_t *p_root = p_this;
589 while( p_root->p_parent != NULL &&
590 p_root != VLC_OBJECT( p_this->p_libvlc ) )
592 p_root = p_root->p_parent;
595 p_found = FindObjectName( p_root, psz_name,
596 (i_mode & ~0x000f)|FIND_CHILD );
597 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
599 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
600 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
605 p_found = FindObjectName( p_this, psz_name, i_mode );
608 vlc_mutex_unlock( &structure_lock );
614 * Increment an object reference counter.
616 void __vlc_object_yield( vlc_object_t *p_this )
618 vlc_object_internals_t *internals = vlc_internals( p_this );
620 vlc_spin_lock( &internals->ref_spin );
621 /* Avoid obvious freed object uses */
622 assert( internals->i_refcount > 0 );
623 /* Increment the counter */
624 internals->i_refcount++;
625 vlc_spin_unlock( &internals->ref_spin );
628 /*****************************************************************************
629 * Decrement an object refcount
630 * And destroy the object if its refcount reach zero.
631 *****************************************************************************/
632 void __vlc_object_release( vlc_object_t *p_this )
634 vlc_object_internals_t *internals = vlc_internals( p_this );
635 bool b_should_destroy;
637 vlc_spin_lock( &internals->ref_spin );
638 assert( internals->i_refcount > 0 );
640 if( internals->i_refcount > 1 )
643 /* There are still other references to the object */
644 internals->i_refcount--;
645 vlc_spin_unlock( &internals->ref_spin );
648 vlc_spin_unlock( &internals->ref_spin );
651 /* Remember that we cannot hold the spin while waiting on the mutex */
652 vlc_mutex_lock( &structure_lock );
653 /* Take the spin again. Note that another thread may have yielded the
654 * object in the (very short) mean time. */
655 vlc_spin_lock( &internals->ref_spin );
656 b_should_destroy = --internals->i_refcount == 0;
657 vlc_spin_unlock( &internals->ref_spin );
659 if( b_should_destroy )
662 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
665 vlc_object_t *leaked = internals->next;
666 while( leaked != p_this )
668 /* We are leaking this object */
670 "ERROR: leaking object (%p, type:%s, name:%s)\n",
671 leaked, leaked->psz_object_type,
672 leaked->psz_object_name );
673 /* Dump object to ease debugging */
674 vlc_object_dump( leaked );
676 leaked = vlc_internals (leaked)->next;
679 if( internals->next != p_this )
680 /* Dump libvlc object to ease debugging */
681 vlc_object_dump( p_this );
684 /* Remove the object from object list
685 * so that it cannot be encountered by vlc_object_get() */
686 vlc_internals (internals->next)->prev = internals->prev;
687 vlc_internals (internals->prev)->next = internals->next;
689 /* Detach from parent to protect against FIND_CHILDREN */
690 vlc_object_detach_unlocked (p_this);
691 /* Detach from children to protect against FIND_PARENT */
692 for (int i = 0; i < internals->i_children; i++)
693 internals->pp_children[i]->p_parent = NULL;
696 vlc_mutex_unlock( &structure_lock );
698 if( b_should_destroy )
702 free( internals->pp_children );
703 internals->pp_children = NULL;
704 internals->i_children = 0;
705 canc = vlc_savecancel ();
706 vlc_object_destroy( p_this );
707 vlc_restorecancel (canc);
712 ****************************************************************************
713 * attach object to a parent object
714 *****************************************************************************
715 * This function sets p_this as a child of p_parent, and p_parent as a parent
716 * of p_this. This link can be undone using vlc_object_detach.
717 *****************************************************************************/
718 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
720 if( !p_this ) return;
722 vlc_mutex_lock( &structure_lock );
724 /* Attach the parent to its child */
725 assert (!p_this->p_parent);
726 p_this->p_parent = p_parent;
728 /* Attach the child to its parent */
729 vlc_object_internals_t *priv = vlc_internals( p_parent );
730 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
733 vlc_mutex_unlock( &structure_lock );
737 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
739 vlc_assert_locked (&structure_lock);
741 if (p_this->p_parent == NULL)
744 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
748 /* Remove p_this's parent */
749 p_this->p_parent = NULL;
751 /* Remove all of p_parent's children which are p_this */
752 for( i_index = priv->i_children ; i_index-- ; )
754 if( priv->pp_children[i_index] == p_this )
757 for( i = i_index ; i < priv->i_children ; i++ )
758 priv->pp_children[i] = priv->pp_children[i+1];
762 if( priv->i_children )
764 vlc_object_t **pp_children = (vlc_object_t **)
765 realloc( priv->pp_children,
766 priv->i_children * sizeof(vlc_object_t *) );
768 priv->pp_children = pp_children;
772 /* Special case - don't realloc() to zero to avoid leaking */
773 free( priv->pp_children );
774 priv->pp_children = NULL;
780 ****************************************************************************
781 * detach object from its parent
782 *****************************************************************************
783 * This function removes all links between an object and its parent.
784 *****************************************************************************/
785 void __vlc_object_detach( vlc_object_t *p_this )
787 if( !p_this ) return;
789 vlc_mutex_lock( &structure_lock );
790 if( !p_this->p_parent )
791 msg_Err( p_this, "object is not attached" );
793 vlc_object_detach_unlocked( p_this );
794 vlc_mutex_unlock( &structure_lock );
799 ****************************************************************************
800 * find a list typed objects and increment their refcount
801 *****************************************************************************
802 * This function recursively looks for a given object type. i_mode can be one
803 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
804 *****************************************************************************/
805 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
810 /* Look for the objects */
811 switch( i_mode & 0x000f )
814 /* Modules should probably not be object, and the module should perhaps
815 * not be shared across LibVLC instances. In the mean time, this ugly
816 * hack is brought to you by Courmisch. */
817 if (i_type == VLC_OBJECT_MODULE)
818 return vlc_list_find ((vlc_object_t *)p_module_bank,
820 return vlc_list_find (p_this->p_libvlc, i_type, FIND_CHILD);
823 vlc_mutex_lock( &structure_lock );
824 i_count = CountChildren( p_this, i_type );
825 p_list = NewList( i_count );
827 /* Check allocation was successful */
828 if( p_list->i_count != i_count )
830 vlc_mutex_unlock( &structure_lock );
831 msg_Err( p_this, "list allocation failed!" );
837 ListChildren( p_list, p_this, i_type );
838 vlc_mutex_unlock( &structure_lock );
842 msg_Err( p_this, "unimplemented!" );
843 p_list = NewList( 0 );
851 * Gets the list of children of an objects, and increment their reference
853 * @return a list (possibly empty) or NULL in case of error.
855 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
858 vlc_object_internals_t *priv = vlc_internals( obj );
860 vlc_mutex_lock( &structure_lock );
861 l = NewList( priv->i_children );
862 for (int i = 0; i < l->i_count; i++)
864 vlc_object_yield( priv->pp_children[i] );
865 l->p_values[i].p_object = priv->pp_children[i];
867 vlc_mutex_unlock( &structure_lock );
871 /*****************************************************************************
872 * DumpCommand: print the current vlc structure
873 *****************************************************************************
874 * This function prints either an ASCII tree showing the connections between
875 * vlc objects, and additional information such as their refcount, thread ID,
876 * etc. (command "tree"), or the same data as a simple list (command "list").
877 *****************************************************************************/
878 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
879 vlc_value_t oldval, vlc_value_t newval, void *p_data )
881 libvlc_int_t *p_libvlc = p_this->p_libvlc;
883 (void)oldval; (void)p_data;
884 if( *psz_cmd == 'l' )
886 vlc_object_t *cur = VLC_OBJECT (p_libvlc);
888 vlc_mutex_lock( &structure_lock );
891 PrintObject (cur, "");
892 cur = vlc_internals (cur)->next;
894 while (cur != VLC_OBJECT(p_libvlc));
895 vlc_mutex_unlock( &structure_lock );
899 vlc_object_t *p_object = NULL;
901 if( *newval.psz_string )
904 int i_id = strtol( newval.psz_string, &end, 0 );
905 /* try using the object's name to find it */
906 p_object = vlc_object_find_name( p_this, newval.psz_string,
914 vlc_mutex_lock( &structure_lock );
916 if( *psz_cmd == 't' )
918 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
921 p_object = VLC_OBJECT(p_this->p_libvlc);
924 DumpStructure( p_object, 0, psz_foo );
926 else if( *psz_cmd == 'v' )
931 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
933 PrintObject( p_object, "" );
935 if( !vlc_internals( p_object )->i_vars )
936 printf( " `-o No variables\n" );
937 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
939 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
941 const char *psz_type = "unknown";
942 switch( p_var->i_type & VLC_VAR_TYPE )
944 #define MYCASE( type, nice ) \
945 case VLC_VAR_ ## type: \
948 MYCASE( VOID, "void" );
949 MYCASE( BOOL, "bool" );
950 MYCASE( INTEGER, "integer" );
951 MYCASE( HOTKEY, "hotkey" );
952 MYCASE( STRING, "string" );
953 MYCASE( MODULE, "module" );
954 MYCASE( FILE, "file" );
955 MYCASE( DIRECTORY, "directory" );
956 MYCASE( VARIABLE, "variable" );
957 MYCASE( FLOAT, "float" );
958 MYCASE( TIME, "time" );
959 MYCASE( ADDRESS, "address" );
960 MYCASE( MUTEX, "mutex" );
961 MYCASE( LIST, "list" );
964 printf( " %c-o \"%s\" (%s",
965 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
966 p_var->psz_name, psz_type );
967 if( p_var->psz_text )
968 printf( ", %s", p_var->psz_text );
970 if( p_var->i_type & VLC_VAR_HASCHOICE )
971 printf( ", has choices" );
972 if( p_var->i_type & VLC_VAR_ISCOMMAND )
973 printf( ", command" );
974 if( p_var->i_entries )
975 printf( ", %d callbacks", p_var->i_entries );
976 switch( p_var->i_type & VLC_VAR_CLASS )
982 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
984 case VLC_VAR_INTEGER:
985 printf( ": %d", p_var->val.i_int );
988 printf( ": \"%s\"", p_var->val.psz_string );
991 printf( ": %f", p_var->val.f_float );
994 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
996 case VLC_VAR_ADDRESS:
997 printf( ": %p", p_var->val.p_address );
1007 vlc_mutex_unlock( &structure_lock );
1009 if( *newval.psz_string )
1011 vlc_object_release( p_object );
1018 /*****************************************************************************
1019 * vlc_list_release: free a list previously allocated by vlc_list_find
1020 *****************************************************************************
1021 * This function decreases the refcount of all objects in the list and
1023 *****************************************************************************/
1024 void vlc_list_release( vlc_list_t *p_list )
1028 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1030 vlc_object_release( p_list->p_values[i_index].p_object );
1033 free( p_list->p_values );
1037 /*****************************************************************************
1038 * dump an object. (Debug function)
1039 *****************************************************************************/
1040 static void vlc_object_dump( vlc_object_t *p_this )
1042 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1045 vlc_assert_locked( &structure_lock );
1046 DumpStructure( p_this, 0, psz_foo );
1049 /* Following functions are local */
1051 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1054 vlc_object_t *p_tmp;
1056 switch( i_mode & 0x000f )
1059 p_tmp = p_this->p_parent;
1062 if( p_tmp->i_object_type == i_type )
1064 vlc_object_yield( p_tmp );
1069 return FindObject( p_tmp, i_type, i_mode );
1075 for( i = vlc_internals( p_this )->i_children; i--; )
1077 p_tmp = vlc_internals( p_this )->pp_children[i];
1078 if( p_tmp->i_object_type == i_type )
1080 vlc_object_yield( p_tmp );
1083 else if( vlc_internals( p_tmp )->i_children )
1085 p_tmp = FindObject( p_tmp, i_type, i_mode );
1095 /* Handled in vlc_object_find */
1102 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1103 const char *psz_name,
1107 vlc_object_t *p_tmp;
1109 switch( i_mode & 0x000f )
1112 p_tmp = p_this->p_parent;
1115 if( p_tmp->psz_object_name
1116 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1118 vlc_object_yield( p_tmp );
1123 return FindObjectName( p_tmp, psz_name, i_mode );
1129 for( i = vlc_internals( p_this )->i_children; i--; )
1131 p_tmp = vlc_internals( p_this )->pp_children[i];
1132 if( p_tmp->psz_object_name
1133 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1135 vlc_object_yield( p_tmp );
1138 else if( vlc_internals( p_tmp )->i_children )
1140 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1150 /* Handled in vlc_object_find */
1158 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1160 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1163 int canc = vlc_savecancel ();
1164 memset( &psz_name, 0, sizeof(psz_name) );
1165 if( p_this->psz_object_name )
1167 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1169 psz_name[48] = '\"';
1172 psz_children[0] = '\0';
1173 switch( vlc_internals( p_this )->i_children )
1178 strcpy( psz_children, ", 1 child" );
1181 snprintf( psz_children, 19, ", %i children",
1182 vlc_internals( p_this )->i_children );
1186 psz_refcount[0] = '\0';
1187 if( vlc_internals( p_this )->i_refcount > 0 )
1188 snprintf( psz_refcount, 19, ", refcount %u",
1189 vlc_internals( p_this )->i_refcount );
1191 psz_thread[0] = '\0';
1192 if( vlc_internals( p_this )->b_thread )
1193 snprintf( psz_thread, 29, " (thread %lu)",
1194 (unsigned long)vlc_internals( p_this )->thread_id );
1196 psz_parent[0] = '\0';
1197 if( p_this->p_parent )
1198 snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
1200 printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
1201 p_this, p_this->psz_object_type,
1202 psz_name, psz_thread, psz_refcount, psz_children,
1204 vlc_restorecancel (canc);
1207 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1210 char i_back = psz_foo[i_level];
1211 psz_foo[i_level] = '\0';
1213 PrintObject( p_this, psz_foo );
1215 psz_foo[i_level] = i_back;
1217 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1219 msg_Warn( p_this, "structure tree is too deep" );
1223 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1227 psz_foo[i_level-1] = ' ';
1229 if( psz_foo[i_level-2] == '`' )
1231 psz_foo[i_level-2] = ' ';
1235 if( i == vlc_internals( p_this )->i_children - 1 )
1237 psz_foo[i_level] = '`';
1241 psz_foo[i_level] = '|';
1244 psz_foo[i_level+1] = '-';
1245 psz_foo[i_level+2] = '\0';
1247 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1252 static vlc_list_t * NewList( int i_count )
1254 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1255 if( p_list == NULL )
1260 p_list->i_count = i_count;
1264 p_list->p_values = NULL;
1268 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1269 if( p_list->p_values == NULL )
1271 p_list->i_count = 0;
1278 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1281 if( p_list == NULL || i_index >= p_list->i_count )
1286 vlc_object_yield( p_object );
1288 p_list->p_values[i_index].p_object = p_object;
1293 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1295 if( p_list == NULL )
1300 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1301 * sizeof( vlc_value_t ) );
1302 if( p_list->p_values == NULL )
1304 p_list->i_count = 0;
1308 vlc_object_yield( p_object );
1310 p_list->p_values[p_list->i_count].p_object = p_object;
1316 static int CountChildren( vlc_object_t *p_this, int i_type )
1318 vlc_object_t *p_tmp;
1321 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1323 p_tmp = vlc_internals( p_this )->pp_children[i];
1325 if( p_tmp->i_object_type == i_type )
1329 i_count += CountChildren( p_tmp, i_type );
1335 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1337 vlc_object_t *p_tmp;
1340 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1342 p_tmp = vlc_internals( p_this )->pp_children[i];
1344 if( p_tmp->i_object_type == i_type )
1345 ListReplace( p_list, p_tmp, p_list->i_count++ );
1347 ListChildren( p_list, p_tmp, i_type );