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"
43 #include "audio_output/aout_internal.h"
45 #include "vlc_interface.h"
46 #include "vlc_codec.h"
48 #include "variables.h"
54 # include <errno.h> /* ENOSYS */
59 #if defined (HAVE_SYS_EVENTFD_H)
60 # include <sys/eventfd.h>
61 # define HAVE_EVENTFD 1
65 /*****************************************************************************
67 *****************************************************************************/
68 static int DumpCommand( vlc_object_t *, char const *,
69 vlc_value_t, vlc_value_t, void * );
71 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
72 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
73 static void PrintObject ( vlc_object_t *, const char * );
74 static void DumpStructure ( vlc_object_t *, int, char * );
76 static vlc_list_t * NewList ( int );
77 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
78 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
79 static int CountChildren ( vlc_object_t *, int );
80 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
82 static void vlc_object_destroy( vlc_object_t *p_this );
83 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
85 static void vlc_object_dump( vlc_object_t *p_this );
88 /*****************************************************************************
89 * Local structure lock
90 *****************************************************************************/
91 static void libvlc_lock (libvlc_int_t *p_libvlc)
93 vlc_mutex_lock (&(libvlc_priv (p_libvlc)->structure_lock));
96 static void libvlc_unlock (libvlc_int_t *p_libvlc)
98 vlc_mutex_unlock (&(libvlc_priv (p_libvlc)->structure_lock));
101 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
102 int i_type, const char *psz_type )
105 vlc_object_internals_t *p_priv;
108 * VLC objects are laid out as follow:
109 * - first the LibVLC-private per-object data,
110 * - then VLC_COMMON members from vlc_object_t,
111 * - finally, the type-specific data (if any).
113 * This function initializes the LibVLC and common data,
114 * and zeroes the rest.
116 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
120 assert (i_size >= sizeof (vlc_object_t));
121 p_new = (vlc_object_t *)(p_priv + 1);
123 p_priv->i_object_type = i_type;
124 p_new->psz_object_type = psz_type;
125 p_new->psz_object_name = NULL;
127 p_new->b_die = false;
128 p_new->b_error = false;
129 p_new->b_force = false;
131 p_new->psz_header = NULL;
134 p_new->i_flags = p_this->i_flags
135 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
137 p_priv->p_vars = calloc( 16, sizeof( variable_t ) );
139 if( !p_priv->p_vars )
147 libvlc_int_t *self = (libvlc_int_t*)p_new;
148 p_new->p_libvlc = self;
149 vlc_mutex_init (&(libvlc_priv (self)->structure_lock));
150 p_this = p_priv->next = p_priv->prev = p_new;
153 p_new->p_libvlc = p_this->p_libvlc;
155 vlc_spin_init( &p_priv->ref_spin );
156 p_priv->i_refcount = 1;
157 p_priv->pf_destructor = NULL;
158 p_priv->b_thread = false;
159 p_new->p_parent = NULL;
160 p_priv->pp_children = NULL;
161 p_priv->i_children = 0;
163 p_new->p_private = NULL;
165 /* Initialize mutexes and condvars */
166 vlc_mutex_init( &p_priv->var_lock );
167 vlc_cond_init( &p_priv->var_wait );
168 p_priv->pipes[0] = p_priv->pipes[1] = -1;
170 p_priv->next = p_this;
171 libvlc_lock (p_new->p_libvlc);
172 p_priv->prev = vlc_internals (p_this)->prev;
173 vlc_internals (p_this)->prev = p_new;
174 vlc_internals (p_priv->prev)->next = p_new;
175 libvlc_unlock (p_new->p_libvlc);
177 if (p_new == VLC_OBJECT(p_new->p_libvlc))
178 { /* TODO: should be in src/libvlc.c */
179 int canc = vlc_savecancel ();
180 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
181 var_AddCallback( p_new, "list", DumpCommand, NULL );
182 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
183 var_AddCallback( p_new, "tree", DumpCommand, NULL );
184 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
185 var_AddCallback( p_new, "vars", DumpCommand, NULL );
186 vlc_restorecancel (canc);
194 * Allocates and initializes a vlc object.
196 * @param i_type known object type (all of them are negative integer values),
197 * or object byte size (always positive).
199 * @return the new object, or NULL on error.
201 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
203 const char * psz_type;
208 case VLC_OBJECT_INTF:
209 i_size = sizeof(intf_thread_t);
210 psz_type = "interface";
212 case VLC_OBJECT_DECODER:
213 i_size = sizeof(decoder_t);
214 psz_type = "decoder";
216 case VLC_OBJECT_PACKETIZER:
217 i_size = sizeof(decoder_t);
218 psz_type = "packetizer";
220 case VLC_OBJECT_AOUT:
221 i_size = sizeof(aout_instance_t);
222 psz_type = "audio output";
225 assert( i_type > 0 ); /* unknown type?! */
227 i_type = VLC_OBJECT_GENERIC;
228 psz_type = "generic";
232 return vlc_custom_create( p_this, i_size, i_type, psz_type );
237 ****************************************************************************
238 * Set the destructor of a vlc object
240 * This function sets the destructor of the vlc object. It will be called
241 * when the object is destroyed when the its refcount reaches 0.
242 * (It is called by the internal function vlc_object_destroy())
243 *****************************************************************************/
244 void __vlc_object_set_destructor( vlc_object_t *p_this,
245 vlc_destructor_t pf_destructor )
247 vlc_object_internals_t *p_priv = vlc_internals(p_this );
248 p_priv->pf_destructor = pf_destructor;
252 ****************************************************************************
253 * Destroy a vlc object (Internal)
255 * This function destroys an object that has been previously allocated with
256 * vlc_object_create. The object's refcount must be zero and it must not be
257 * attached to other objects in any way.
259 * This function must be called with cancellation disabled (currently).
260 *****************************************************************************/
261 static void vlc_object_destroy( vlc_object_t *p_this )
263 vlc_object_internals_t *p_priv = vlc_internals( p_this );
265 /* Objects are always detached beforehand */
266 assert( !p_this->p_parent );
268 /* Send a kill to the object's thread if applicable */
269 vlc_object_kill( p_this );
271 /* Call the custom "subclass" destructor */
272 if( p_priv->pf_destructor )
273 p_priv->pf_destructor( p_this );
275 /* Any thread must have been cleaned up at this point. */
276 assert( !p_priv->b_thread );
278 /* Destroy the associated variables, starting from the end so that
279 * no memmove calls have to be done. */
280 while( p_priv->i_vars )
282 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
285 free( p_priv->p_vars );
286 vlc_cond_destroy( &p_priv->var_wait );
287 vlc_mutex_destroy( &p_priv->var_lock );
289 free( p_this->psz_header );
291 FREENULL( p_this->psz_object_name );
293 vlc_spin_destroy( &p_priv->ref_spin );
294 if( p_priv->pipes[1] != -1 && p_priv->pipes[1] != p_priv->pipes[0] )
295 close( p_priv->pipes[1] );
296 if( p_priv->pipes[0] != -1 )
297 close( p_priv->pipes[0] );
298 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
299 vlc_mutex_destroy (&(libvlc_priv ((libvlc_int_t *)p_this)->structure_lock));
306 # include <winsock2.h>
307 # include <ws2tcpip.h>
310 * select()-able pipes emulated using Winsock
312 static int pipe (int fd[2])
315 int addrlen = sizeof (addr);
317 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
318 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
319 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
322 memset (&addr, 0, sizeof (addr));
323 addr.sin_family = AF_INET;
324 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
325 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
326 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
328 || connect (c, (PSOCKADDR)&addr, addrlen))
331 a = accept (l, NULL, NULL);
332 if (a == INVALID_SOCKET)
343 if (l != INVALID_SOCKET)
345 if (c != INVALID_SOCKET)
351 #define read( a, b, c ) recv (a, b, c, 0)
353 #define write( a, b, c ) send (a, b, c, 0)
355 #define close( a ) closesocket (a)
358 static vlc_mutex_t pipe_lock = VLC_STATIC_MUTEX;
361 * Returns the readable end of a pipe that becomes readable once termination
362 * of the object is requested (vlc_object_kill()).
363 * This can be used to wake-up out of a select() or poll() event loop, such
364 * typically when doing network I/O.
366 * Note that the pipe will remain the same for the lifetime of the object.
367 * DO NOT read the pipe nor close it yourself. Ever.
369 * @param obj object that would be "killed"
370 * @return a readable pipe descriptor, or -1 on error.
372 int vlc_object_waitpipe( vlc_object_t *obj )
374 vlc_object_internals_t *internals = vlc_internals( obj );
376 vlc_mutex_lock (&pipe_lock);
377 if (internals->pipes[0] == -1)
379 /* This can only ever happen if someone killed us without locking: */
380 assert (internals->pipes[1] == -1);
383 internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
384 if (internals->pipes[0] == -1)
387 if (pipe (internals->pipes))
388 internals->pipes[0] = internals->pipes[1] = -1;
391 if (internals->pipes[0] != -1 && obj->b_die)
392 { /* Race condition: vlc_object_kill() already invoked! */
393 msg_Dbg (obj, "waitpipe: object already dying");
394 write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
397 vlc_mutex_unlock (&pipe_lock);
398 return internals->pipes[0];
403 * Requests termination of an object, cancels the object thread, and make the
404 * object wait pipe (if it exists) readable. Not a cancellation point.
406 void __vlc_object_kill( vlc_object_t *p_this )
408 vlc_object_internals_t *priv = vlc_internals( p_this );
411 vlc_thread_cancel( p_this );
412 vlc_mutex_lock( &pipe_lock );
416 p_this->b_die = true;
419 /* This also serves as a memory barrier toward vlc_object_alive(): */
420 vlc_mutex_unlock( &pipe_lock );
424 int canc = vlc_savecancel ();
426 /* write _after_ setting b_die, so vlc_object_alive() returns false */
427 write (fd, &(uint64_t){ 1 }, sizeof (uint64_t));
428 msg_Dbg (p_this, "waitpipe: object killed");
429 vlc_restorecancel (canc);
434 /*****************************************************************************
435 * find a typed object and increment its refcount
436 *****************************************************************************
437 * This function recursively looks for a given object type. i_mode can be one
438 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
439 *****************************************************************************/
440 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
442 vlc_object_t *p_found;
444 /* If we are of the requested type ourselves, don't look further */
445 if( !(i_mode & FIND_STRICT)
446 && vlc_internals (p_this)->i_object_type == i_type )
448 vlc_object_hold( p_this );
452 /* Otherwise, recursively look for the object */
453 if ((i_mode & 0x000f) == FIND_ANYWHERE)
454 return vlc_object_find (p_this->p_libvlc, i_type,
455 (i_mode & ~0x000f)|FIND_CHILD);
457 libvlc_lock (p_this->p_libvlc);
458 p_found = FindObject( p_this, i_type, i_mode );
459 libvlc_unlock (p_this->p_libvlc);
463 #undef vlc_object_find_name
465 * Finds a named object and increment its reference count.
466 * Beware that objects found in this manner can be "owned" by another thread,
467 * be of _any_ type, and be attached to any module (if any). With such an
468 * object reference, you can set or get object variables, emit log messages,
469 * and read write-once object parameters (psz_object_type, etc).
470 * You CANNOT cast the object to a more specific object type, and you
471 * definitely cannot invoke object type-specific callbacks with this.
473 * @param p_this object to search from
474 * @param psz_name name of the object to search for
475 * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
477 * @return a matching object (must be released by the caller),
480 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
481 const char *psz_name, int i_mode )
483 vlc_object_t *p_found;
485 /* If have the requested name ourselves, don't look further */
486 if( !(i_mode & FIND_STRICT)
487 && p_this->psz_object_name
488 && !strcmp( p_this->psz_object_name, psz_name ) )
490 vlc_object_hold( p_this );
494 libvlc_lock (p_this->p_libvlc);
496 /* Otherwise, recursively look for the object */
497 if( (i_mode & 0x000f) == FIND_ANYWHERE )
499 vlc_object_t *p_root = p_this;
502 while( p_root->p_parent != NULL &&
503 p_root != VLC_OBJECT( p_this->p_libvlc ) )
505 p_root = p_root->p_parent;
508 p_found = FindObjectName( p_root, psz_name,
509 (i_mode & ~0x000f)|FIND_CHILD );
510 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
512 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
513 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
518 p_found = FindObjectName( p_this, psz_name, i_mode );
521 libvlc_unlock (p_this->p_libvlc);
526 * Increment an object reference counter.
528 void * __vlc_object_hold( vlc_object_t *p_this )
530 vlc_object_internals_t *internals = vlc_internals( p_this );
532 vlc_spin_lock( &internals->ref_spin );
533 /* Avoid obvious freed object uses */
534 assert( internals->i_refcount > 0 );
535 /* Increment the counter */
536 internals->i_refcount++;
537 vlc_spin_unlock( &internals->ref_spin );
541 /*****************************************************************************
542 * Decrement an object refcount
543 * And destroy the object if its refcount reach zero.
544 *****************************************************************************/
545 void __vlc_object_release( vlc_object_t *p_this )
547 vlc_object_internals_t *internals = vlc_internals( p_this );
548 vlc_object_t *parent = NULL;
549 bool b_should_destroy;
551 vlc_spin_lock( &internals->ref_spin );
552 assert( internals->i_refcount > 0 );
554 if( internals->i_refcount > 1 )
557 /* There are still other references to the object */
558 internals->i_refcount--;
559 vlc_spin_unlock( &internals->ref_spin );
562 vlc_spin_unlock( &internals->ref_spin );
565 /* Remember that we cannot hold the spin while waiting on the mutex */
566 libvlc_lock (p_this->p_libvlc);
567 /* Take the spin again. Note that another thread may have held the
568 * object in the (very short) mean time. */
569 vlc_spin_lock( &internals->ref_spin );
570 b_should_destroy = --internals->i_refcount == 0;
571 vlc_spin_unlock( &internals->ref_spin );
573 if( b_should_destroy )
575 /* We have no children */
576 assert (internals->i_children == 0);
577 parent = p_this->p_parent;
580 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
583 vlc_object_t *leaked = internals->next;
584 while( leaked != p_this )
586 /* We are leaking this object */
588 "ERROR: leaking object (%p, type:%s, name:%s)\n",
589 leaked, leaked->psz_object_type,
590 leaked->psz_object_name );
591 /* Dump object to ease debugging */
592 vlc_object_dump( leaked );
594 leaked = vlc_internals (leaked)->next;
597 if( internals->next != p_this )
598 /* Dump libvlc object to ease debugging */
599 vlc_object_dump( p_this );
602 /* Remove the object from object list
603 * so that it cannot be encountered by vlc_object_get() */
604 vlc_internals (internals->next)->prev = internals->prev;
605 vlc_internals (internals->prev)->next = internals->next;
608 /* Detach from parent to protect against FIND_CHILDREN */
609 vlc_object_detach_unlocked (p_this);
611 libvlc_unlock (p_this->p_libvlc);
613 if( b_should_destroy )
617 canc = vlc_savecancel ();
618 vlc_object_destroy( p_this );
619 vlc_restorecancel (canc);
621 vlc_object_release (parent);
626 ****************************************************************************
627 * attach object to a parent object
628 *****************************************************************************
629 * This function sets p_this as a child of p_parent, and p_parent as a parent
630 * of p_this. This link can be undone using vlc_object_detach.
631 *****************************************************************************/
632 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
634 if( !p_this ) return;
636 vlc_object_hold (p_parent);
637 libvlc_lock (p_this->p_libvlc);
639 /* Attach the parent to its child */
640 assert (!p_this->p_parent);
641 p_this->p_parent = p_parent;
643 /* Attach the child to its parent */
644 vlc_object_internals_t *priv = vlc_internals( p_parent );
645 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
647 libvlc_unlock (p_this->p_libvlc);
651 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
653 if (p_this->p_parent == NULL)
656 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
660 /* Remove p_this's parent */
661 p_this->p_parent = NULL;
663 /* Remove all of p_parent's children which are p_this */
664 for( i_index = priv->i_children ; i_index-- ; )
666 if( priv->pp_children[i_index] == p_this )
669 for( i = i_index ; i < priv->i_children ; i++ )
670 priv->pp_children[i] = priv->pp_children[i+1];
674 if( priv->i_children )
676 vlc_object_t **pp_children = (vlc_object_t **)
677 realloc( priv->pp_children,
678 priv->i_children * sizeof(vlc_object_t *) );
680 priv->pp_children = pp_children;
684 /* Special case - don't realloc() to zero to avoid leaking */
685 free( priv->pp_children );
686 priv->pp_children = NULL;
692 ****************************************************************************
693 * detach object from its parent
694 *****************************************************************************
695 * This function removes all links between an object and its parent.
696 *****************************************************************************/
697 void __vlc_object_detach( vlc_object_t *p_this )
699 vlc_object_t *p_parent;
700 if( !p_this ) return;
702 libvlc_lock (p_this->p_libvlc);
703 p_parent = p_this->p_parent;
705 vlc_object_detach_unlocked( p_this );
706 libvlc_unlock (p_this->p_libvlc);
709 vlc_object_release (p_parent);
714 ****************************************************************************
715 * find a list typed objects and increment their refcount
716 *****************************************************************************
717 * This function recursively looks for a given object type. i_mode can be one
718 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
719 *****************************************************************************/
720 vlc_list_t * vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
725 /* Look for the objects */
726 switch( i_mode & 0x000f )
729 return vlc_list_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
732 libvlc_lock (p_this->p_libvlc);
733 i_count = CountChildren( p_this, i_type );
734 p_list = NewList( i_count );
736 /* Check allocation was successful */
737 if( p_list->i_count != i_count )
739 libvlc_unlock (p_this->p_libvlc);
745 ListChildren( p_list, p_this, i_type );
746 libvlc_unlock (p_this->p_libvlc);
750 msg_Err( p_this, "unimplemented!" );
751 p_list = NewList( 0 );
759 * Gets the list of children of an objects, and increment their reference
761 * @return a list (possibly empty) or NULL in case of error.
763 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
766 vlc_object_internals_t *priv = vlc_internals( obj );
768 libvlc_lock (obj->p_libvlc);
769 l = NewList( priv->i_children );
770 for (int i = 0; i < l->i_count; i++)
772 vlc_object_hold( priv->pp_children[i] );
773 l->p_values[i].p_object = priv->pp_children[i];
775 libvlc_unlock (obj->p_libvlc);
779 /*****************************************************************************
780 * DumpCommand: print the current vlc structure
781 *****************************************************************************
782 * This function prints either an ASCII tree showing the connections between
783 * vlc objects, and additional information such as their refcount, thread ID,
784 * etc. (command "tree"), or the same data as a simple list (command "list").
785 *****************************************************************************/
786 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
787 vlc_value_t oldval, vlc_value_t newval, void *p_data )
789 libvlc_int_t *p_libvlc = p_this->p_libvlc;
791 (void)oldval; (void)p_data;
792 if( *psz_cmd == 'l' )
794 vlc_object_t *cur = VLC_OBJECT (p_libvlc);
796 libvlc_lock (p_this->p_libvlc);
799 PrintObject (cur, "");
800 cur = vlc_internals (cur)->next;
802 while (cur != VLC_OBJECT(p_libvlc));
803 libvlc_unlock (p_this->p_libvlc);
807 vlc_object_t *p_object = NULL;
809 if( *newval.psz_string )
811 /* try using the object's name to find it */
812 p_object = vlc_object_find_name( p_this, newval.psz_string,
820 libvlc_lock (p_this->p_libvlc);
821 if( *psz_cmd == 't' )
823 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
826 p_object = VLC_OBJECT(p_this->p_libvlc);
829 DumpStructure( p_object, 0, psz_foo );
831 else if( *psz_cmd == 'v' )
836 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
838 PrintObject( p_object, "" );
840 if( !vlc_internals( p_object )->i_vars )
841 printf( " `-o No variables\n" );
842 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
844 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
846 const char *psz_type = "unknown";
847 switch( p_var->i_type & VLC_VAR_TYPE )
849 #define MYCASE( type, nice ) \
850 case VLC_VAR_ ## type: \
853 MYCASE( VOID, "void" );
854 MYCASE( BOOL, "bool" );
855 MYCASE( INTEGER, "integer" );
856 MYCASE( HOTKEY, "hotkey" );
857 MYCASE( STRING, "string" );
858 MYCASE( MODULE, "module" );
859 MYCASE( FILE, "file" );
860 MYCASE( DIRECTORY, "directory" );
861 MYCASE( VARIABLE, "variable" );
862 MYCASE( FLOAT, "float" );
863 MYCASE( TIME, "time" );
864 MYCASE( ADDRESS, "address" );
865 MYCASE( MUTEX, "mutex" );
866 MYCASE( LIST, "list" );
869 printf( " %c-o \"%s\" (%s",
870 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
871 p_var->psz_name, psz_type );
872 if( p_var->psz_text )
873 printf( ", %s", p_var->psz_text );
875 if( p_var->i_type & VLC_VAR_HASCHOICE )
876 printf( ", has choices" );
877 if( p_var->i_type & VLC_VAR_ISCOMMAND )
878 printf( ", command" );
879 if( p_var->i_entries )
880 printf( ", %d callbacks", p_var->i_entries );
881 switch( p_var->i_type & VLC_VAR_CLASS )
887 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
889 case VLC_VAR_INTEGER:
890 printf( ": %d", p_var->val.i_int );
893 printf( ": \"%s\"", p_var->val.psz_string );
896 printf( ": %f", p_var->val.f_float );
899 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
901 case VLC_VAR_ADDRESS:
902 printf( ": %p", p_var->val.p_address );
911 libvlc_unlock (p_this->p_libvlc);
913 if( *newval.psz_string )
915 vlc_object_release( p_object );
922 /*****************************************************************************
923 * vlc_list_release: free a list previously allocated by vlc_list_find
924 *****************************************************************************
925 * This function decreases the refcount of all objects in the list and
927 *****************************************************************************/
928 void vlc_list_release( vlc_list_t *p_list )
932 for( i_index = 0; i_index < p_list->i_count; i_index++ )
934 vlc_object_release( p_list->p_values[i_index].p_object );
937 free( p_list->p_values );
941 /*****************************************************************************
942 * dump an object. (Debug function)
943 *****************************************************************************/
945 static void vlc_object_dump( vlc_object_t *p_this )
947 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
950 DumpStructure( p_this, 0, psz_foo );
954 /* Following functions are local */
956 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
961 switch( i_mode & 0x000f )
964 p_tmp = p_this->p_parent;
967 if( vlc_internals( p_tmp )->i_object_type == i_type )
969 vlc_object_hold( p_tmp );
974 return FindObject( p_tmp, i_type, i_mode );
980 for( i = vlc_internals( p_this )->i_children; i--; )
982 p_tmp = vlc_internals( p_this )->pp_children[i];
983 if( vlc_internals( p_tmp )->i_object_type == i_type )
985 vlc_object_hold( p_tmp );
988 else if( vlc_internals( p_tmp )->i_children )
990 p_tmp = FindObject( p_tmp, i_type, i_mode );
1000 /* Handled in vlc_object_find */
1007 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1008 const char *psz_name,
1012 vlc_object_t *p_tmp;
1014 switch( i_mode & 0x000f )
1017 p_tmp = p_this->p_parent;
1020 if( p_tmp->psz_object_name
1021 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1023 vlc_object_hold( p_tmp );
1028 return FindObjectName( p_tmp, psz_name, i_mode );
1034 for( i = vlc_internals( p_this )->i_children; i--; )
1036 p_tmp = vlc_internals( p_this )->pp_children[i];
1037 if( p_tmp->psz_object_name
1038 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1040 vlc_object_hold( p_tmp );
1043 else if( vlc_internals( p_tmp )->i_children )
1045 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1055 /* Handled in vlc_object_find */
1063 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1065 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1068 int canc = vlc_savecancel ();
1069 memset( &psz_name, 0, sizeof(psz_name) );
1070 if( p_this->psz_object_name )
1072 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1074 psz_name[48] = '\"';
1077 psz_children[0] = '\0';
1078 switch( vlc_internals( p_this )->i_children )
1083 strcpy( psz_children, ", 1 child" );
1086 snprintf( psz_children, 19, ", %i children",
1087 vlc_internals( p_this )->i_children );
1091 psz_refcount[0] = '\0';
1092 if( vlc_internals( p_this )->i_refcount > 0 )
1093 snprintf( psz_refcount, 19, ", refcount %u",
1094 vlc_internals( p_this )->i_refcount );
1096 psz_thread[0] = '\0';
1097 if( vlc_internals( p_this )->b_thread )
1098 snprintf( psz_thread, 29, " (thread %lu)",
1099 (unsigned long)vlc_internals( p_this )->thread_id );
1101 psz_parent[0] = '\0';
1102 if( p_this->p_parent )
1103 snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
1105 printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
1106 p_this, p_this->psz_object_type,
1107 psz_name, psz_thread, psz_refcount, psz_children,
1109 vlc_restorecancel (canc);
1112 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1115 char i_back = psz_foo[i_level];
1116 psz_foo[i_level] = '\0';
1118 PrintObject( p_this, psz_foo );
1120 psz_foo[i_level] = i_back;
1122 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1124 msg_Warn( p_this, "structure tree is too deep" );
1128 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1132 psz_foo[i_level-1] = ' ';
1134 if( psz_foo[i_level-2] == '`' )
1136 psz_foo[i_level-2] = ' ';
1140 if( i == vlc_internals( p_this )->i_children - 1 )
1142 psz_foo[i_level] = '`';
1146 psz_foo[i_level] = '|';
1149 psz_foo[i_level+1] = '-';
1150 psz_foo[i_level+2] = '\0';
1152 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1157 static vlc_list_t * NewList( int i_count )
1159 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1160 if( p_list == NULL )
1165 p_list->i_count = i_count;
1169 p_list->p_values = NULL;
1173 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1174 if( p_list->p_values == NULL )
1176 p_list->i_count = 0;
1183 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1186 if( p_list == NULL || i_index >= p_list->i_count )
1191 vlc_object_hold( p_object );
1193 p_list->p_values[i_index].p_object = p_object;
1198 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1200 if( p_list == NULL )
1205 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1206 * sizeof( vlc_value_t ) );
1207 if( p_list->p_values == NULL )
1209 p_list->i_count = 0;
1213 vlc_object_hold( p_object );
1215 p_list->p_values[p_list->i_count].p_object = p_object;
1221 static int CountChildren( vlc_object_t *p_this, int i_type )
1223 vlc_object_t *p_tmp;
1226 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1228 p_tmp = vlc_internals( p_this )->pp_children[i];
1230 if( vlc_internals( p_tmp )->i_object_type == i_type )
1234 i_count += CountChildren( p_tmp, i_type );
1240 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1242 vlc_object_t *p_tmp;
1245 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1247 p_tmp = vlc_internals( p_this )->pp_children[i];
1249 if( vlc_internals( p_tmp )->i_object_type == i_type )
1250 ListReplace( p_list, p_tmp, p_list->i_count++ );
1252 ListChildren( p_list, p_tmp, i_type );