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 */
60 #if defined (HAVE_SYS_EVENTFD_H)
61 # include <sys/eventfd.h>
62 # define HAVE_EVENTFD 1
66 /*****************************************************************************
68 *****************************************************************************/
69 static int DumpCommand( vlc_object_t *, char const *,
70 vlc_value_t, vlc_value_t, void * );
72 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
73 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
74 static void PrintObject ( vlc_object_t *, const char * );
75 static void DumpStructure ( vlc_object_t *, int, char * );
77 static vlc_list_t * NewList ( int );
78 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
79 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
80 static int CountChildren ( vlc_object_t *, int );
81 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
83 static void vlc_object_destroy( vlc_object_t *p_this );
84 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
86 static void vlc_object_dump( vlc_object_t *p_this );
89 /*****************************************************************************
90 * Local structure lock
91 *****************************************************************************/
92 static void libvlc_lock (libvlc_int_t *p_libvlc)
94 vlc_mutex_lock (&(libvlc_priv (p_libvlc)->structure_lock));
97 static void libvlc_unlock (libvlc_int_t *p_libvlc)
99 vlc_mutex_unlock (&(libvlc_priv (p_libvlc)->structure_lock));
102 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
103 int i_type, const char *psz_type )
106 vlc_object_internals_t *p_priv;
109 * VLC objects are laid out as follow:
110 * - first the LibVLC-private per-object data,
111 * - then VLC_COMMON members from vlc_object_t,
112 * - finally, the type-specific data (if any).
114 * This function initializes the LibVLC and common data,
115 * and zeroes the rest.
117 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
121 assert (i_size >= sizeof (vlc_object_t));
122 p_new = (vlc_object_t *)(p_priv + 1);
124 p_priv->i_object_type = i_type;
125 p_new->psz_object_type = psz_type;
126 p_priv->psz_name = NULL;
128 p_new->b_die = false;
129 p_new->b_error = false;
130 p_new->b_force = false;
132 p_new->psz_header = NULL;
135 p_new->i_flags = p_this->i_flags
136 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
138 p_priv->p_vars = calloc( 16, sizeof( variable_t ) );
140 if( !p_priv->p_vars )
148 libvlc_int_t *self = (libvlc_int_t*)p_new;
149 p_new->p_libvlc = self;
150 vlc_mutex_init (&(libvlc_priv (self)->structure_lock));
151 p_this = p_priv->next = p_priv->prev = p_new;
154 p_new->p_libvlc = p_this->p_libvlc;
156 vlc_spin_init( &p_priv->ref_spin );
157 p_priv->i_refcount = 1;
158 p_priv->pf_destructor = NULL;
159 p_priv->b_thread = false;
160 p_new->p_parent = NULL;
161 p_priv->pp_children = NULL;
162 p_priv->i_children = 0;
164 /* Initialize mutexes and condvars */
165 vlc_mutex_init( &p_priv->var_lock );
166 vlc_cond_init( &p_priv->var_wait );
167 p_priv->pipes[0] = p_priv->pipes[1] = -1;
169 p_priv->next = p_this;
170 libvlc_lock (p_new->p_libvlc);
171 p_priv->prev = vlc_internals (p_this)->prev;
172 vlc_internals (p_this)->prev = p_new;
173 vlc_internals (p_priv->prev)->next = p_new;
174 libvlc_unlock (p_new->p_libvlc);
176 if (p_new == VLC_OBJECT(p_new->p_libvlc))
177 { /* TODO: should be in src/libvlc.c */
178 int canc = vlc_savecancel ();
179 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
180 var_AddCallback( p_new, "list", DumpCommand, NULL );
181 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
182 var_AddCallback( p_new, "tree", DumpCommand, NULL );
183 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
184 var_AddCallback( p_new, "vars", DumpCommand, NULL );
185 vlc_restorecancel (canc);
193 * Allocates and initializes a vlc object.
195 * @param i_type known object type (all of them are negative integer values),
196 * or object byte size (always positive).
198 * @return the new object, or NULL on error.
200 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
202 const char * psz_type;
207 case VLC_OBJECT_DECODER:
208 i_size = sizeof(decoder_t);
209 psz_type = "decoder";
211 case VLC_OBJECT_AOUT:
212 i_size = sizeof(aout_instance_t);
213 psz_type = "audio output";
216 assert( i_type > 0 ); /* unknown type?! */
218 i_type = VLC_OBJECT_GENERIC;
219 psz_type = "generic";
223 return vlc_custom_create( p_this, i_size, i_type, psz_type );
228 ****************************************************************************
229 * Set the destructor of a vlc object
231 * This function sets the destructor of the vlc object. It will be called
232 * when the object is destroyed when the its refcount reaches 0.
233 * (It is called by the internal function vlc_object_destroy())
234 *****************************************************************************/
235 void __vlc_object_set_destructor( vlc_object_t *p_this,
236 vlc_destructor_t pf_destructor )
238 vlc_object_internals_t *p_priv = vlc_internals(p_this );
240 vlc_spin_lock( &p_priv->ref_spin );
241 p_priv->pf_destructor = pf_destructor;
242 vlc_spin_unlock( &p_priv->ref_spin );
245 #undef vlc_object_set_name
246 int vlc_object_set_name(vlc_object_t *obj, const char *name)
248 vlc_object_internals_t *priv = vlc_internals(obj);
250 /* Object must be named before it is attached (or never) */
251 assert(obj->p_parent == NULL);
252 assert(priv->i_children == 0);
254 free(priv->psz_name);
255 priv->psz_name = name ? strdup(name) : NULL;
256 return (priv->psz_name || !name) ? VLC_SUCCESS : VLC_ENOMEM;
260 ****************************************************************************
261 * Destroy a vlc object (Internal)
263 * This function destroys an object that has been previously allocated with
264 * vlc_object_create. The object's refcount must be zero and it must not be
265 * attached to other objects in any way.
267 * This function must be called with cancellation disabled (currently).
268 *****************************************************************************/
269 static void vlc_object_destroy( vlc_object_t *p_this )
271 vlc_object_internals_t *p_priv = vlc_internals( p_this );
273 /* Objects are always detached beforehand */
274 assert( !p_this->p_parent );
276 /* Send a kill to the object's thread if applicable */
277 vlc_object_kill( p_this );
279 /* Call the custom "subclass" destructor */
280 if( p_priv->pf_destructor )
281 p_priv->pf_destructor( p_this );
283 /* Any thread must have been cleaned up at this point. */
284 assert( !p_priv->b_thread );
286 /* Destroy the associated variables, starting from the end so that
287 * no memmove calls have to be done. */
288 while( p_priv->i_vars )
290 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
293 free( p_priv->p_vars );
294 vlc_cond_destroy( &p_priv->var_wait );
295 vlc_mutex_destroy( &p_priv->var_lock );
297 free( p_this->psz_header );
299 free( p_priv->psz_name );
301 vlc_spin_destroy( &p_priv->ref_spin );
302 if( p_priv->pipes[1] != -1 && p_priv->pipes[1] != p_priv->pipes[0] )
303 close( p_priv->pipes[1] );
304 if( p_priv->pipes[0] != -1 )
305 close( p_priv->pipes[0] );
306 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
307 vlc_mutex_destroy (&(libvlc_priv ((libvlc_int_t *)p_this)->structure_lock));
314 # include <winsock2.h>
315 # include <ws2tcpip.h>
318 * select()-able pipes emulated using Winsock
320 static int pipe (int fd[2])
323 int addrlen = sizeof (addr);
325 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
326 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
327 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
330 memset (&addr, 0, sizeof (addr));
331 addr.sin_family = AF_INET;
332 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
333 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
334 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
336 || connect (c, (PSOCKADDR)&addr, addrlen))
339 a = accept (l, NULL, NULL);
340 if (a == INVALID_SOCKET)
351 if (l != INVALID_SOCKET)
353 if (c != INVALID_SOCKET)
359 #define read( a, b, c ) recv (a, b, c, 0)
361 #define write( a, b, c ) send (a, b, c, 0)
363 #define close( a ) closesocket (a)
366 static vlc_mutex_t pipe_lock = VLC_STATIC_MUTEX;
369 * Returns the readable end of a pipe that becomes readable once termination
370 * of the object is requested (vlc_object_kill()).
371 * This can be used to wake-up out of a select() or poll() event loop, such
372 * typically when doing network I/O.
374 * Note that the pipe will remain the same for the lifetime of the object.
375 * DO NOT read the pipe nor close it yourself. Ever.
377 * @param obj object that would be "killed"
378 * @return a readable pipe descriptor, or -1 on error.
380 int vlc_object_waitpipe( vlc_object_t *obj )
382 vlc_object_internals_t *internals = vlc_internals( obj );
384 vlc_mutex_lock (&pipe_lock);
385 if (internals->pipes[0] == -1)
387 /* This can only ever happen if someone killed us without locking: */
388 assert (internals->pipes[1] == -1);
391 internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
392 if (internals->pipes[0] == -1)
395 if (pipe (internals->pipes))
396 internals->pipes[0] = internals->pipes[1] = -1;
399 if (internals->pipes[0] != -1 && obj->b_die)
400 { /* Race condition: vlc_object_kill() already invoked! */
401 msg_Dbg (obj, "waitpipe: object already dying");
402 write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
405 vlc_mutex_unlock (&pipe_lock);
406 return internals->pipes[0];
411 * Requests termination of an object, cancels the object thread, and make the
412 * object wait pipe (if it exists) readable. Not a cancellation point.
414 void __vlc_object_kill( vlc_object_t *p_this )
416 vlc_object_internals_t *priv = vlc_internals( p_this );
419 vlc_thread_cancel( p_this );
420 vlc_mutex_lock( &pipe_lock );
424 p_this->b_die = true;
427 /* This also serves as a memory barrier toward vlc_object_alive(): */
428 vlc_mutex_unlock( &pipe_lock );
432 int canc = vlc_savecancel ();
434 /* write _after_ setting b_die, so vlc_object_alive() returns false */
435 write (fd, &(uint64_t){ 1 }, sizeof (uint64_t));
436 msg_Dbg (p_this, "waitpipe: object killed");
437 vlc_restorecancel (canc);
442 /*****************************************************************************
443 * find a typed object and increment its refcount
444 *****************************************************************************
445 * This function recursively looks for a given object type. i_mode can be one
446 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
447 *****************************************************************************/
448 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
450 vlc_object_t *p_found;
452 /* If we are of the requested type ourselves, don't look further */
453 if( !(i_mode & FIND_STRICT)
454 && vlc_internals (p_this)->i_object_type == i_type )
456 vlc_object_hold( p_this );
460 /* Otherwise, recursively look for the object */
461 if ((i_mode & 0x000f) == FIND_ANYWHERE)
462 return vlc_object_find (p_this->p_libvlc, i_type,
463 (i_mode & ~0x000f)|FIND_CHILD);
465 libvlc_lock (p_this->p_libvlc);
466 p_found = FindObject( p_this, i_type, i_mode );
467 libvlc_unlock (p_this->p_libvlc);
472 static int objnamecmp(const vlc_object_t *obj, const char *name)
474 if (!vlc_object_get_name(obj))
476 return strcmp( vlc_object_get_name(obj), name );
479 #undef vlc_object_find_name
481 * Finds a named object and increment its reference count.
482 * Beware that objects found in this manner can be "owned" by another thread,
483 * be of _any_ type, and be attached to any module (if any). With such an
484 * object reference, you can set or get object variables, emit log messages,
485 * and read write-once object parameters (psz_object_type, etc).
486 * You CANNOT cast the object to a more specific object type, and you
487 * definitely cannot invoke object type-specific callbacks with this.
489 * @param p_this object to search from
490 * @param psz_name name of the object to search for
491 * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
493 * @return a matching object (must be released by the caller),
496 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
497 const char *psz_name, int i_mode )
499 vlc_object_t *p_found;
501 /* Reading psz_object_name from a separate inhibits thread-safety.
502 * Use a libvlc address variable instead for that sort of things! */
503 msg_Warn( p_this, "%s(%s) is not safe!", __func__, psz_name );
504 /* If have the requested name ourselves, don't look further */
505 if( !(i_mode & FIND_STRICT) && !objnamecmp(p_this, psz_name) )
507 vlc_object_hold( p_this );
511 libvlc_lock (p_this->p_libvlc);
513 /* Otherwise, recursively look for the object */
514 if( (i_mode & 0x000f) == FIND_ANYWHERE )
516 vlc_object_t *p_root = p_this;
519 while( p_root->p_parent != NULL &&
520 p_root != VLC_OBJECT( p_this->p_libvlc ) )
522 p_root = p_root->p_parent;
525 p_found = FindObjectName( p_root, psz_name,
526 (i_mode & ~0x000f)|FIND_CHILD );
527 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
529 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
530 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
535 p_found = FindObjectName( p_this, psz_name, i_mode );
538 libvlc_unlock (p_this->p_libvlc);
543 * Increment an object reference counter.
545 void * __vlc_object_hold( vlc_object_t *p_this )
547 vlc_object_internals_t *internals = vlc_internals( p_this );
549 vlc_spin_lock( &internals->ref_spin );
550 /* Avoid obvious freed object uses */
551 assert( internals->i_refcount > 0 );
552 /* Increment the counter */
553 internals->i_refcount++;
554 vlc_spin_unlock( &internals->ref_spin );
558 /*****************************************************************************
559 * Decrement an object refcount
560 * And destroy the object if its refcount reach zero.
561 *****************************************************************************/
562 void __vlc_object_release( vlc_object_t *p_this )
564 vlc_object_internals_t *internals = vlc_internals( p_this );
565 vlc_object_t *parent = NULL;
566 bool b_should_destroy;
568 vlc_spin_lock( &internals->ref_spin );
569 assert( internals->i_refcount > 0 );
571 if( internals->i_refcount > 1 )
574 /* There are still other references to the object */
575 internals->i_refcount--;
576 vlc_spin_unlock( &internals->ref_spin );
579 vlc_spin_unlock( &internals->ref_spin );
582 /* Remember that we cannot hold the spin while waiting on the mutex */
583 libvlc_lock (p_this->p_libvlc);
584 /* Take the spin again. Note that another thread may have held the
585 * object in the (very short) mean time. */
586 vlc_spin_lock( &internals->ref_spin );
587 b_should_destroy = --internals->i_refcount == 0;
588 vlc_spin_unlock( &internals->ref_spin );
590 if( b_should_destroy )
592 parent = p_this->p_parent;
595 if( VLC_OBJECT(p_this->p_libvlc) == p_this )
598 vlc_object_t *leaked = internals->next;
599 while( leaked != p_this )
601 /* We are leaking this object */
603 "ERROR: leaking object (%p, type:%s, name:%s)\n",
604 leaked, leaked->psz_object_type,
605 vlc_object_get_name(leaked) );
606 /* Dump object to ease debugging */
607 vlc_object_dump( leaked );
609 leaked = vlc_internals (leaked)->next;
612 if( internals->next != p_this )
613 /* Dump libvlc object to ease debugging */
614 vlc_object_dump( p_this );
617 /* Remove the object from object list
618 * so that it cannot be encountered by vlc_object_get() */
619 vlc_internals (internals->next)->prev = internals->prev;
620 vlc_internals (internals->prev)->next = internals->next;
623 /* Detach from parent to protect against FIND_CHILDREN */
624 vlc_object_detach_unlocked (p_this);
626 /* We have no children */
627 assert (internals->i_children == 0);
629 libvlc_unlock (p_this->p_libvlc);
631 if( b_should_destroy )
635 canc = vlc_savecancel ();
636 vlc_object_destroy( p_this );
637 vlc_restorecancel (canc);
639 vlc_object_release (parent);
644 ****************************************************************************
645 * attach object to a parent object
646 *****************************************************************************
647 * This function sets p_this as a child of p_parent, and p_parent as a parent
648 * of p_this. This link can be undone using vlc_object_detach.
649 *****************************************************************************/
650 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
652 if( !p_this ) return;
654 vlc_object_hold (p_parent);
655 libvlc_lock (p_this->p_libvlc);
657 /* Attach the parent to its child */
658 assert (!p_this->p_parent);
659 p_this->p_parent = p_parent;
661 /* Attach the child to its parent */
662 vlc_object_internals_t *priv = vlc_internals( p_parent );
663 INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
665 libvlc_unlock (p_this->p_libvlc);
669 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
671 if (p_this->p_parent == NULL)
674 vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
678 /* Remove p_this's parent */
679 p_this->p_parent = NULL;
681 /* Remove all of p_parent's children which are p_this */
682 for( i_index = priv->i_children ; i_index-- ; )
684 if( priv->pp_children[i_index] == p_this )
687 for( i = i_index ; i < priv->i_children ; i++ )
688 priv->pp_children[i] = priv->pp_children[i+1];
692 if( priv->i_children )
694 vlc_object_t **pp_children = (vlc_object_t **)
695 realloc( priv->pp_children,
696 priv->i_children * sizeof(vlc_object_t *) );
698 priv->pp_children = pp_children;
702 /* Special case - don't realloc() to zero to avoid leaking */
703 free( priv->pp_children );
704 priv->pp_children = NULL;
710 ****************************************************************************
711 * detach object from its parent
712 *****************************************************************************
713 * This function removes all links between an object and its parent.
714 *****************************************************************************/
715 void __vlc_object_detach( vlc_object_t *p_this )
717 vlc_object_t *p_parent;
718 if( !p_this ) return;
720 libvlc_lock (p_this->p_libvlc);
721 p_parent = p_this->p_parent;
723 vlc_object_detach_unlocked( p_this );
724 libvlc_unlock (p_this->p_libvlc);
727 vlc_object_release (p_parent);
732 ****************************************************************************
733 * find a list typed objects and increment their refcount
734 *****************************************************************************
735 * This function recursively looks for a given object type. i_mode can be one
736 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
737 *****************************************************************************/
738 vlc_list_t * vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
743 /* Look for the objects */
744 switch( i_mode & 0x000f )
747 return vlc_list_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
750 libvlc_lock (p_this->p_libvlc);
751 i_count = CountChildren( p_this, i_type );
752 p_list = NewList( i_count );
754 /* Check allocation was successful */
755 if( p_list->i_count != i_count )
757 libvlc_unlock (p_this->p_libvlc);
763 ListChildren( p_list, p_this, i_type );
764 libvlc_unlock (p_this->p_libvlc);
768 msg_Err( p_this, "unimplemented!" );
769 p_list = NewList( 0 );
777 * Gets the list of children of an objects, and increment their reference
779 * @return a list (possibly empty) or NULL in case of error.
781 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
784 vlc_object_internals_t *priv = vlc_internals( obj );
786 libvlc_lock (obj->p_libvlc);
787 l = NewList( priv->i_children );
788 for (int i = 0; i < l->i_count; i++)
790 vlc_object_hold( priv->pp_children[i] );
791 l->p_values[i].p_object = priv->pp_children[i];
793 libvlc_unlock (obj->p_libvlc);
797 /*****************************************************************************
798 * DumpCommand: print the current vlc structure
799 *****************************************************************************
800 * This function prints either an ASCII tree showing the connections between
801 * vlc objects, and additional information such as their refcount, thread ID,
802 * etc. (command "tree"), or the same data as a simple list (command "list").
803 *****************************************************************************/
804 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
805 vlc_value_t oldval, vlc_value_t newval, void *p_data )
807 libvlc_int_t *p_libvlc = p_this->p_libvlc;
809 (void)oldval; (void)p_data;
810 if( *psz_cmd == 'l' )
812 vlc_object_t *cur = VLC_OBJECT (p_libvlc);
814 libvlc_lock (p_this->p_libvlc);
817 PrintObject (cur, "");
818 cur = vlc_internals (cur)->next;
820 while (cur != VLC_OBJECT(p_libvlc));
821 libvlc_unlock (p_this->p_libvlc);
825 vlc_object_t *p_object = NULL;
827 if( *newval.psz_string )
829 /* try using the object's name to find it */
830 p_object = vlc_object_find_name( p_this, newval.psz_string,
838 libvlc_lock (p_this->p_libvlc);
839 if( *psz_cmd == 't' )
841 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
844 p_object = VLC_OBJECT(p_this->p_libvlc);
847 DumpStructure( p_object, 0, psz_foo );
849 else if( *psz_cmd == 'v' )
854 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
856 PrintObject( p_object, "" );
858 if( !vlc_internals( p_object )->i_vars )
859 printf( " `-o No variables\n" );
860 for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
862 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
864 const char *psz_type = "unknown";
865 switch( p_var->i_type & VLC_VAR_TYPE )
867 #define MYCASE( type, nice ) \
868 case VLC_VAR_ ## type: \
871 MYCASE( VOID, "void" );
872 MYCASE( BOOL, "bool" );
873 MYCASE( INTEGER, "integer" );
874 MYCASE( HOTKEY, "hotkey" );
875 MYCASE( STRING, "string" );
876 MYCASE( MODULE, "module" );
877 MYCASE( FILE, "file" );
878 MYCASE( DIRECTORY, "directory" );
879 MYCASE( VARIABLE, "variable" );
880 MYCASE( FLOAT, "float" );
881 MYCASE( TIME, "time" );
882 MYCASE( ADDRESS, "address" );
883 MYCASE( MUTEX, "mutex" );
884 MYCASE( LIST, "list" );
887 printf( " %c-o \"%s\" (%s",
888 i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
889 p_var->psz_name, psz_type );
890 if( p_var->psz_text )
891 printf( ", %s", p_var->psz_text );
893 if( p_var->i_type & VLC_VAR_HASCHOICE )
894 printf( ", has choices" );
895 if( p_var->i_type & VLC_VAR_ISCOMMAND )
896 printf( ", command" );
897 if( p_var->i_entries )
898 printf( ", %d callbacks", p_var->i_entries );
899 switch( p_var->i_type & VLC_VAR_CLASS )
905 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
907 case VLC_VAR_INTEGER:
908 printf( ": %d", p_var->val.i_int );
911 printf( ": \"%s\"", p_var->val.psz_string );
914 printf( ": %f", p_var->val.f_float );
917 printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
919 case VLC_VAR_ADDRESS:
920 printf( ": %p", p_var->val.p_address );
929 libvlc_unlock (p_this->p_libvlc);
931 if( *newval.psz_string )
933 vlc_object_release( p_object );
940 /*****************************************************************************
941 * vlc_list_release: free a list previously allocated by vlc_list_find
942 *****************************************************************************
943 * This function decreases the refcount of all objects in the list and
945 *****************************************************************************/
946 void vlc_list_release( vlc_list_t *p_list )
950 for( i_index = 0; i_index < p_list->i_count; i_index++ )
952 vlc_object_release( p_list->p_values[i_index].p_object );
955 free( p_list->p_values );
959 /*****************************************************************************
960 * dump an object. (Debug function)
961 *****************************************************************************/
963 static void vlc_object_dump( vlc_object_t *p_this )
965 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
968 DumpStructure( p_this, 0, psz_foo );
972 /* Following functions are local */
974 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
979 switch( i_mode & 0x000f )
982 p_tmp = p_this->p_parent;
985 if( vlc_internals( p_tmp )->i_object_type == i_type )
987 vlc_object_hold( p_tmp );
992 return FindObject( p_tmp, i_type, i_mode );
998 for( i = vlc_internals( p_this )->i_children; i--; )
1000 p_tmp = vlc_internals( p_this )->pp_children[i];
1001 if( vlc_internals( p_tmp )->i_object_type == i_type )
1003 vlc_object_hold( p_tmp );
1006 else if( vlc_internals( p_tmp )->i_children )
1008 p_tmp = FindObject( p_tmp, i_type, i_mode );
1018 /* Handled in vlc_object_find */
1025 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1026 const char *psz_name,
1030 vlc_object_t *p_tmp;
1032 switch( i_mode & 0x000f )
1035 p_tmp = p_this->p_parent;
1038 if( !objnamecmp(p_tmp, psz_name) )
1040 vlc_object_hold( p_tmp );
1045 return FindObjectName( p_tmp, psz_name, i_mode );
1051 for( i = vlc_internals( p_this )->i_children; i--; )
1053 p_tmp = vlc_internals( p_this )->pp_children[i];
1054 if( !objnamecmp(p_tmp, psz_name ) )
1056 vlc_object_hold( p_tmp );
1059 else if( vlc_internals( p_tmp )->i_children )
1061 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1071 /* Handled in vlc_object_find */
1079 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1081 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1084 int canc = vlc_savecancel ();
1085 memset( &psz_name, 0, sizeof(psz_name) );
1086 if( vlc_object_get_name(p_this) )
1088 snprintf( psz_name, 49, " \"%s\"",
1089 vlc_object_get_name(p_this) );
1091 psz_name[48] = '\"';
1094 psz_children[0] = '\0';
1095 switch( vlc_internals( p_this )->i_children )
1100 strcpy( psz_children, ", 1 child" );
1103 snprintf( psz_children, 19, ", %i children",
1104 vlc_internals( p_this )->i_children );
1108 psz_refcount[0] = '\0';
1109 if( vlc_internals( p_this )->i_refcount > 0 )
1110 snprintf( psz_refcount, 19, ", refcount %u",
1111 vlc_internals( p_this )->i_refcount );
1113 psz_thread[0] = '\0';
1114 if( vlc_internals( p_this )->b_thread )
1115 snprintf( psz_thread, 29, " (thread %lu)",
1116 (unsigned long)vlc_internals( p_this )->thread_id );
1118 psz_parent[0] = '\0';
1119 if( p_this->p_parent )
1120 snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
1122 printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
1123 p_this, p_this->psz_object_type,
1124 psz_name, psz_thread, psz_refcount, psz_children,
1126 vlc_restorecancel (canc);
1129 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1132 char i_back = psz_foo[i_level];
1133 psz_foo[i_level] = '\0';
1135 PrintObject( p_this, psz_foo );
1137 psz_foo[i_level] = i_back;
1139 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1141 msg_Warn( p_this, "structure tree is too deep" );
1145 for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1149 psz_foo[i_level-1] = ' ';
1151 if( psz_foo[i_level-2] == '`' )
1153 psz_foo[i_level-2] = ' ';
1157 if( i == vlc_internals( p_this )->i_children - 1 )
1159 psz_foo[i_level] = '`';
1163 psz_foo[i_level] = '|';
1166 psz_foo[i_level+1] = '-';
1167 psz_foo[i_level+2] = '\0';
1169 DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1174 static vlc_list_t * NewList( int i_count )
1176 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1177 if( p_list == NULL )
1182 p_list->i_count = i_count;
1186 p_list->p_values = NULL;
1190 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1191 if( p_list->p_values == NULL )
1193 p_list->i_count = 0;
1200 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1203 if( p_list == NULL || i_index >= p_list->i_count )
1208 vlc_object_hold( p_object );
1210 p_list->p_values[i_index].p_object = p_object;
1215 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1217 if( p_list == NULL )
1222 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1223 * sizeof( vlc_value_t ) );
1224 if( p_list->p_values == NULL )
1226 p_list->i_count = 0;
1230 vlc_object_hold( p_object );
1232 p_list->p_values[p_list->i_count].p_object = p_object;
1238 static int CountChildren( vlc_object_t *p_this, int i_type )
1240 vlc_object_t *p_tmp;
1243 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1245 p_tmp = vlc_internals( p_this )->pp_children[i];
1247 if( vlc_internals( p_tmp )->i_object_type == i_type )
1251 i_count += CountChildren( p_tmp, i_type );
1257 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1259 vlc_object_t *p_tmp;
1262 for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1264 p_tmp = vlc_internals( p_this )->pp_children[i];
1266 if( vlc_internals( p_tmp )->i_object_type == i_type )
1267 ListReplace( p_list, p_tmp, p_list->i_count++ );
1269 ListChildren( p_list, p_tmp, i_type );