1 /*****************************************************************************
2 * item.c: input_item management
3 *****************************************************************************
4 * Copyright (C) 1998-2004 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
29 #include <vlc_common.h>
30 #include "vlc_playlist.h"
31 #include "vlc_interface.h"
35 static void GuessType( input_item_t *p_item );
37 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
39 static inline void input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
41 memset( p_i, 0, sizeof(input_item_t) );
45 TAB_INIT( p_i->i_es, p_i->es );
46 TAB_INIT( p_i->i_options, p_i->ppsz_options );
47 p_i->optflagv = NULL, p_i->optflagc = 0;
48 TAB_INIT( p_i->i_categories, p_i->pp_categories );
50 p_i->i_type = ITEM_TYPE_UNKNOWN;
51 p_i->b_fixed_name = true;
56 vlc_mutex_init( &p_i->lock );
57 vlc_event_manager_t * p_em = &p_i->event_manager;
58 vlc_event_manager_init( p_em, p_i, p_o );
59 vlc_event_manager_register_event_type( p_em, vlc_InputItemMetaChanged );
60 vlc_event_manager_register_event_type( p_em, vlc_InputItemSubItemAdded );
61 vlc_event_manager_register_event_type( p_em, vlc_InputItemDurationChanged );
62 vlc_event_manager_register_event_type( p_em, vlc_InputItemPreparsedChanged );
63 vlc_event_manager_register_event_type( p_em, vlc_InputItemNameChanged );
64 vlc_event_manager_register_event_type( p_em, vlc_InputItemInfoChanged );
65 vlc_event_manager_register_event_type( p_em, vlc_InputItemErrorWhenReadingChanged );
68 static inline void input_item_Clean( input_item_t *p_i )
72 vlc_event_manager_fini( &p_i->event_manager );
74 free( p_i->psz_name );
78 vlc_mutex_destroy( &p_i->p_stats->lock );
83 vlc_meta_Delete( p_i->p_meta );
85 for( i = 0; i < p_i->i_options; i++ )
86 free( p_i->ppsz_options[i] );
87 TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
90 for( i = 0; i < p_i->i_es; i++ )
92 es_format_Clean( p_i->es[i] );
95 TAB_CLEAN( p_i->i_es, p_i->es );
97 for( i = 0; i < p_i->i_categories; i++ )
99 info_category_t *p_category = p_i->pp_categories[i];
102 for( j = 0; j < p_category->i_infos; j++ )
104 struct info_t *p_info = p_category->pp_infos[j];
106 free( p_info->psz_name);
107 free( p_info->psz_value );
110 TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
112 free( p_category->psz_name );
115 TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
117 vlc_mutex_destroy( &p_i->lock );
119 void input_item_SetErrorWhenReading( input_item_t *p_i, bool b_error )
123 vlc_mutex_lock( &p_i->lock );
125 b_changed = p_i->b_error_when_reading != b_error;
126 p_i->b_error_when_reading = b_error;
128 vlc_mutex_unlock( &p_i->lock );
134 event.type = vlc_InputItemErrorWhenReadingChanged;
135 event.u.input_item_error_when_reading_changed.new_value = b_error;
136 vlc_event_send( &p_i->event_manager, &event );
139 void input_item_SetPreparsed( input_item_t *p_i, bool b_preparsed )
141 bool b_send_event = false;
143 vlc_mutex_lock( &p_i->lock );
146 p_i->p_meta = vlc_meta_New();
150 i_new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
152 i_new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
153 if( p_i->p_meta->i_status != i_new_status )
155 p_i->p_meta->i_status = i_new_status;
159 vlc_mutex_unlock( &p_i->lock );
164 event.type = vlc_InputItemPreparsedChanged;
165 event.u.input_item_preparsed_changed.new_status = i_new_status;
166 vlc_event_send( &p_i->event_manager, &event );
169 void input_item_SetArtNotFound( input_item_t *p_i, bool b_not_found )
171 vlc_mutex_lock( &p_i->lock );
174 p_i->p_meta = vlc_meta_New();
177 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
179 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
181 vlc_mutex_unlock( &p_i->lock );
183 void input_item_SetArtFetched( input_item_t *p_i, bool b_art_fetched )
185 vlc_mutex_lock( &p_i->lock );
188 p_i->p_meta = vlc_meta_New();
191 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
193 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
195 vlc_mutex_unlock( &p_i->lock );
198 void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
202 vlc_mutex_lock( &p_i->lock );
204 p_i->p_meta = vlc_meta_New();
205 vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
206 vlc_mutex_unlock( &p_i->lock );
208 /* Notify interested third parties */
209 event.type = vlc_InputItemMetaChanged;
210 event.u.input_item_meta_changed.meta_type = meta_type;
211 vlc_event_send( &p_i->event_manager, &event );
214 /* FIXME GRRRRRRRRRR args should be in the reverse order to be
215 * consistant with (nearly?) all or copy funcs */
216 void input_item_CopyOptions( input_item_t *p_parent,
217 input_item_t *p_child )
219 vlc_mutex_lock( &p_parent->lock );
221 for( int i = 0 ; i< p_parent->i_options; i++ )
223 if( !strcmp( p_parent->ppsz_options[i], "meta-file" ) )
226 input_item_AddOpt( p_child,
227 p_parent->ppsz_options[i],
228 p_parent->optflagv[i] );
231 vlc_mutex_unlock( &p_parent->lock );
234 /* This won't hold the item, but can tell to interested third parties
235 * Like the playlist, that there is a new sub item. With this design
236 * It is not the input item's responsability to keep all the ref of
237 * the input item children. */
238 void input_item_AddSubItem( input_item_t *p_parent, input_item_t *p_child )
240 vlc_mutex_lock( &p_parent->lock );
242 p_parent->i_type = ITEM_TYPE_PLAYLIST;
244 vlc_mutex_unlock( &p_parent->lock );
246 /* Notify interested third parties */
249 event.type = vlc_InputItemSubItemAdded;
250 event.u.input_item_subitem_added.p_new_child = p_child;
251 vlc_event_send( &p_parent->event_manager, &event );
254 int input_item_AddOption( input_item_t *p_item, const char *psz_option )
256 return input_item_AddOpt( p_item, psz_option, VLC_INPUT_OPTION_TRUSTED );
259 bool input_item_HasErrorWhenReading( input_item_t *p_item )
261 vlc_mutex_lock( &p_item->lock );
263 bool b_error = p_item->b_error_when_reading;
265 vlc_mutex_unlock( &p_item->lock );
270 bool input_item_MetaMatch( input_item_t *p_i,
271 vlc_meta_type_t meta_type, const char *psz )
273 vlc_mutex_lock( &p_i->lock );
277 vlc_mutex_unlock( &p_i->lock );
280 const char *psz_meta = vlc_meta_Get( p_i->p_meta, meta_type );
281 bool b_ret = psz_meta && strcasestr( psz_meta, psz );
283 vlc_mutex_unlock( &p_i->lock );
288 char *input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
290 vlc_mutex_lock( &p_i->lock );
294 vlc_mutex_unlock( &p_i->lock );
299 if( vlc_meta_Get( p_i->p_meta, meta_type ) )
300 psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
302 vlc_mutex_unlock( &p_i->lock );
306 char *input_item_GetName( input_item_t *p_item )
308 vlc_mutex_lock( &p_item->lock );
310 char *psz_name = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
312 vlc_mutex_unlock( &p_item->lock );
315 void input_item_SetName( input_item_t *p_item, const char *psz_name )
317 vlc_mutex_lock( &p_item->lock );
319 free( p_item->psz_name );
320 p_item->psz_name = strdup( psz_name );
322 vlc_mutex_unlock( &p_item->lock );
325 char *input_item_GetURI( input_item_t *p_i )
327 vlc_mutex_lock( &p_i->lock );
329 char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
331 vlc_mutex_unlock( &p_i->lock );
334 void input_item_SetURI( input_item_t *p_i, char *psz_uri )
336 vlc_mutex_lock( &p_i->lock );
338 free( p_i->psz_uri );
339 p_i->psz_uri = strdup( psz_uri );
341 vlc_mutex_unlock( &p_i->lock );
344 mtime_t input_item_GetDuration( input_item_t *p_i )
346 vlc_mutex_lock( &p_i->lock );
348 mtime_t i_duration = p_i->i_duration;
350 vlc_mutex_unlock( &p_i->lock );
354 void input_item_SetDuration( input_item_t *p_i, mtime_t i_duration )
356 bool b_send_event = false;
358 vlc_mutex_lock( &p_i->lock );
359 if( p_i->i_duration != i_duration )
361 p_i->i_duration = i_duration;
364 vlc_mutex_unlock( &p_i->lock );
370 event.type = vlc_InputItemDurationChanged;
371 event.u.input_item_duration_changed.new_duration = i_duration;
372 vlc_event_send( &p_i->event_manager, &event );
377 bool input_item_IsPreparsed( input_item_t *p_item )
379 vlc_mutex_lock( &p_item->lock );
380 bool b_preparsed = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_PREPARSED ) != 0 : false;
381 vlc_mutex_unlock( &p_item->lock );
386 bool input_item_IsArtFetched( input_item_t *p_item )
388 vlc_mutex_lock( &p_item->lock );
389 bool b_fetched = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_ART_FETCHED ) != 0 : false;
390 vlc_mutex_unlock( &p_item->lock );
396 * Get a info item from a given category in a given input item.
398 * \param p_i The input item to get info from
399 * \param psz_cat String representing the category for the info
400 * \param psz_name String representing the name of the desired info
401 * \return A pointer to the string with the given info if found, or an
402 * empty string otherwise. The caller should free the returned
405 char *input_item_GetInfo( input_item_t *p_i,
407 const char *psz_name )
409 vlc_mutex_lock( &p_i->lock );
411 for( int i = 0; i< p_i->i_categories; i++ )
413 const info_category_t *p_cat = p_i->pp_categories[i];
415 if( !psz_cat || strcmp( p_cat->psz_name, psz_cat ) )
418 for( int j = 0; j < p_cat->i_infos; j++ )
420 if( !strcmp( p_cat->pp_infos[j]->psz_name, psz_name ) )
422 char *psz_ret = strdup( p_cat->pp_infos[j]->psz_value );
423 vlc_mutex_unlock( &p_i->lock );
428 vlc_mutex_unlock( &p_i->lock );
432 static void input_item_Destroy ( gc_object_t *p_gc )
434 input_item_t *p_item = vlc_priv( p_gc, input_item_t );
436 input_item_Clean( p_item );
440 int input_item_AddOpt( input_item_t *p_input, const char *psz_option,
443 int err = VLC_SUCCESS;
445 if( psz_option == NULL )
448 vlc_mutex_lock( &p_input->lock );
449 if (flags & VLC_INPUT_OPTION_UNIQUE)
451 for (int i = 0 ; i < p_input->i_options; i++)
452 if( !strcmp( p_input->ppsz_options[i], psz_option ) )
456 uint8_t *flagv = realloc (p_input->optflagv, p_input->optflagc + 1);
462 p_input->optflagv = flagv;
463 flagv[p_input->optflagc++] = flags;
465 INSERT_ELEM( p_input->ppsz_options, p_input->i_options,
466 p_input->i_options, strdup( psz_option ) );
468 vlc_mutex_unlock( &p_input->lock );
472 int input_item_AddInfo( input_item_t *p_i,
474 const char *psz_name,
475 const char *psz_format, ... )
479 info_t *p_info = NULL;
480 info_category_t *p_cat = NULL ;
482 vlc_mutex_lock( &p_i->lock );
484 for( i = 0 ; i < p_i->i_categories ; i ++ )
486 if( !strcmp( p_i->pp_categories[i]->psz_name, psz_cat ) )
488 p_cat = p_i->pp_categories[i];
494 if( !(p_cat = (info_category_t *)malloc( sizeof(info_category_t) )) )
496 vlc_mutex_unlock( &p_i->lock );
499 p_cat->psz_name = strdup( psz_cat );
502 INSERT_ELEM( p_i->pp_categories, p_i->i_categories, p_i->i_categories,
506 for( i = 0; i< p_cat->i_infos; i++ )
508 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
510 p_info = p_cat->pp_infos[i];
517 if( ( p_info = (info_t *)malloc( sizeof( info_t ) ) ) == NULL )
519 vlc_mutex_unlock( &p_i->lock );
522 INSERT_ELEM( p_cat->pp_infos, p_cat->i_infos, p_cat->i_infos, p_info );
523 p_info->psz_name = strdup( psz_name );
527 free( p_info->psz_value );
530 va_start( args, psz_format );
531 if( vasprintf( &p_info->psz_value, psz_format, args) == -1 )
532 p_info->psz_value = NULL;
535 vlc_mutex_unlock( &p_i->lock );
537 if( p_info->psz_value )
541 event.type = vlc_InputItemInfoChanged;
542 vlc_event_send( &p_i->event_manager, &event );
544 return p_info->psz_value ? VLC_SUCCESS : VLC_ENOMEM;
546 int input_item_DelInfo( input_item_t *p_i,
548 const char *psz_name )
550 info_category_t *p_cat = NULL;
554 vlc_mutex_lock( &p_i->lock );
555 for( i_cat = 0; i_cat < p_i->i_categories; i_cat++ )
557 if( !strcmp( p_i->pp_categories[i_cat]->psz_name,
560 p_cat = p_i->pp_categories[i_cat];
566 vlc_mutex_unlock( &p_i->lock );
572 /* Remove a specific info */
573 for( i = 0; i < p_cat->i_infos; i++ )
575 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
577 free( p_cat->pp_infos[i]->psz_name );
578 if( p_cat->pp_infos[i]->psz_value )
579 free( p_cat->pp_infos[i]->psz_value );
580 free( p_cat->pp_infos[i] );
581 REMOVE_ELEM( p_cat->pp_infos, p_cat->i_infos, i );
585 if( i >= p_cat->i_infos )
587 vlc_mutex_unlock( &p_i->lock );
593 /* Remove the complete categorie */
594 for( i = 0; i < p_cat->i_infos; i++ )
596 free( p_cat->pp_infos[i]->psz_name );
597 if( p_cat->pp_infos[i]->psz_value )
598 free( p_cat->pp_infos[i]->psz_value );
599 free( p_cat->pp_infos[i] );
601 if( p_cat->pp_infos )
602 free( p_cat->pp_infos );
603 REMOVE_ELEM( p_i->pp_categories, p_i->i_categories, i_cat );
605 vlc_mutex_unlock( &p_i->lock );
609 event.type = vlc_InputItemInfoChanged;
610 vlc_event_send( &p_i->event_manager, &event );
616 input_item_t *__input_item_NewExt( vlc_object_t *p_obj, const char *psz_uri,
617 const char *psz_name,
619 const char *const *ppsz_options,
622 return input_item_NewWithType( p_obj, psz_uri, psz_name,
623 i_options, ppsz_options,
624 i_duration, ITEM_TYPE_UNKNOWN );
628 input_item_t *input_item_NewWithType( vlc_object_t *p_obj, const char *psz_uri,
629 const char *psz_name,
631 const char *const *ppsz_options,
635 libvlc_priv_t *priv = libvlc_priv (p_obj->p_libvlc);
637 input_item_t* p_input = malloc( sizeof(input_item_t ) );
641 input_item_Init( p_obj, p_input );
642 vlc_gc_init( p_input, input_item_Destroy );
644 vlc_object_lock( p_obj->p_libvlc );
645 p_input->i_id = ++priv->i_last_input_id;
646 vlc_object_unlock( p_obj->p_libvlc );
648 p_input->b_fixed_name = false;
651 p_input->psz_uri = strdup( psz_uri );
653 p_input->psz_uri = NULL;
655 p_input->i_type = i_type;
656 p_input->b_prefers_tree = false;
658 if( p_input->i_type == ITEM_TYPE_UNKNOWN )
659 GuessType( p_input );
661 if( psz_name != NULL )
662 p_input->psz_name = strdup( psz_name );
663 else if( p_input->i_type == ITEM_TYPE_FILE && p_input->psz_uri )
665 const char *psz_filename = strrchr( p_input->psz_uri, DIR_SEP_CHAR );
666 if( psz_filename && *psz_filename == DIR_SEP_CHAR )
668 p_input->psz_name = strdup( psz_filename && *psz_filename
669 ? psz_filename : p_input->psz_uri );
672 p_input->psz_name = p_input->psz_uri ? strdup( p_input->psz_uri ) : NULL;
674 p_input->i_duration = i_duration;
676 for( int i = 0; i < i_options; i++ )
677 input_item_AddOption( p_input, ppsz_options[i] );
681 /* Guess the type of the item using the beginning of the mrl */
682 static void GuessType( input_item_t *p_item)
685 static struct { const char *psz_search; int i_type; } types_array[] =
687 { "http", ITEM_TYPE_NET },
688 { "dvd", ITEM_TYPE_DISC },
689 { "cdda", ITEM_TYPE_CDDA },
690 { "mms", ITEM_TYPE_NET },
691 { "rtsp", ITEM_TYPE_NET },
692 { "udp", ITEM_TYPE_NET },
693 { "rtp", ITEM_TYPE_NET },
694 { "vcd", ITEM_TYPE_DISC },
695 { "v4l", ITEM_TYPE_CARD },
696 { "dshow", ITEM_TYPE_CARD },
697 { "pvr", ITEM_TYPE_CARD },
698 { "dvb", ITEM_TYPE_CARD },
699 { "qpsk", ITEM_TYPE_CARD },
700 { "sdp", ITEM_TYPE_NET },
704 if( !p_item->psz_uri )
706 p_item->i_type = ITEM_TYPE_FILE;
710 for( i = 0; types_array[i].psz_search != NULL; i++ )
712 if( !strncmp( p_item->psz_uri, types_array[i].psz_search,
713 strlen( types_array[i].psz_search ) ) )
715 p_item->i_type = types_array[i].i_type;
719 p_item->i_type = ITEM_TYPE_FILE;