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_AddOption( 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 bool input_item_HasErrorWhenReading( input_item_t *p_item )
256 vlc_mutex_lock( &p_item->lock );
258 bool b_error = p_item->b_error_when_reading;
260 vlc_mutex_unlock( &p_item->lock );
265 bool input_item_MetaMatch( input_item_t *p_i,
266 vlc_meta_type_t meta_type, const char *psz )
268 vlc_mutex_lock( &p_i->lock );
272 vlc_mutex_unlock( &p_i->lock );
275 const char *psz_meta = vlc_meta_Get( p_i->p_meta, meta_type );
276 bool b_ret = psz_meta && strcasestr( psz_meta, psz );
278 vlc_mutex_unlock( &p_i->lock );
283 char *input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
285 vlc_mutex_lock( &p_i->lock );
289 vlc_mutex_unlock( &p_i->lock );
294 if( vlc_meta_Get( p_i->p_meta, meta_type ) )
295 psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
297 vlc_mutex_unlock( &p_i->lock );
301 /* Get the title of a given item or fallback to the name if the title is empty */
302 char *input_item_GetTitleFbName( input_item_t *p_item )
305 vlc_mutex_lock( &p_item->lock );
307 if( !p_item->p_meta )
309 vlc_mutex_unlock( &p_item->lock );
313 const char *psz_meta = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
314 if( !EMPTY_STR( psz_meta ) )
315 psz_ret = strdup( psz_meta );
317 psz_ret = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
319 vlc_mutex_unlock( &p_item->lock );
323 char *input_item_GetName( input_item_t *p_item )
325 vlc_mutex_lock( &p_item->lock );
327 char *psz_name = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
329 vlc_mutex_unlock( &p_item->lock );
332 void input_item_SetName( input_item_t *p_item, const char *psz_name )
334 vlc_mutex_lock( &p_item->lock );
336 free( p_item->psz_name );
337 p_item->psz_name = strdup( psz_name );
339 vlc_mutex_unlock( &p_item->lock );
342 char *input_item_GetURI( input_item_t *p_i )
344 vlc_mutex_lock( &p_i->lock );
346 char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
348 vlc_mutex_unlock( &p_i->lock );
351 void input_item_SetURI( input_item_t *p_i, const char *psz_uri )
353 vlc_mutex_lock( &p_i->lock );
355 free( p_i->psz_uri );
356 p_i->psz_uri = strdup( psz_uri );
360 if( !p_i->psz_name && p_i->i_type == ITEM_TYPE_FILE )
362 const char *psz_filename = strrchr( p_i->psz_uri, DIR_SEP_CHAR );
363 if( psz_filename && *psz_filename == DIR_SEP_CHAR )
365 if( psz_filename && *psz_filename )
366 p_i->psz_name = strdup( psz_filename );
370 p_i->psz_name = strdup( p_i->psz_uri );
372 vlc_mutex_unlock( &p_i->lock );
375 mtime_t input_item_GetDuration( input_item_t *p_i )
377 vlc_mutex_lock( &p_i->lock );
379 mtime_t i_duration = p_i->i_duration;
381 vlc_mutex_unlock( &p_i->lock );
385 void input_item_SetDuration( input_item_t *p_i, mtime_t i_duration )
387 bool b_send_event = false;
389 vlc_mutex_lock( &p_i->lock );
390 if( p_i->i_duration != i_duration )
392 p_i->i_duration = i_duration;
395 vlc_mutex_unlock( &p_i->lock );
401 event.type = vlc_InputItemDurationChanged;
402 event.u.input_item_duration_changed.new_duration = i_duration;
403 vlc_event_send( &p_i->event_manager, &event );
408 bool input_item_IsPreparsed( input_item_t *p_item )
410 vlc_mutex_lock( &p_item->lock );
411 bool b_preparsed = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_PREPARSED ) != 0 : false;
412 vlc_mutex_unlock( &p_item->lock );
417 bool input_item_IsArtFetched( input_item_t *p_item )
419 vlc_mutex_lock( &p_item->lock );
420 bool b_fetched = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_ART_FETCHED ) != 0 : false;
421 vlc_mutex_unlock( &p_item->lock );
426 static void input_item_Destroy ( gc_object_t *p_gc )
428 input_item_t *p_item = vlc_priv( p_gc, input_item_t );
430 input_item_Clean( p_item );
434 int input_item_AddOption( input_item_t *p_input, const char *psz_option,
437 int err = VLC_SUCCESS;
439 if( psz_option == NULL )
442 vlc_mutex_lock( &p_input->lock );
443 if (flags & VLC_INPUT_OPTION_UNIQUE)
445 for (int i = 0 ; i < p_input->i_options; i++)
446 if( !strcmp( p_input->ppsz_options[i], psz_option ) )
450 uint8_t *flagv = realloc (p_input->optflagv, p_input->optflagc + 1);
456 p_input->optflagv = flagv;
457 flagv[p_input->optflagc++] = flags;
459 INSERT_ELEM( p_input->ppsz_options, p_input->i_options,
460 p_input->i_options, strdup( psz_option ) );
462 vlc_mutex_unlock( &p_input->lock );
467 * Get a info item from a given category in a given input item.
469 * \param p_i The input item to get info from
470 * \param psz_cat String representing the category for the info
471 * \param psz_name String representing the name of the desired info
472 * \return A pointer to the string with the given info if found, or an
473 * empty string otherwise. The caller should free the returned
476 char *input_item_GetInfo( input_item_t *p_i,
478 const char *psz_name )
480 vlc_mutex_lock( &p_i->lock );
482 for( int i = 0; i< p_i->i_categories; i++ )
484 const info_category_t *p_cat = p_i->pp_categories[i];
486 if( !psz_cat || strcmp( p_cat->psz_name, psz_cat ) )
489 for( int j = 0; j < p_cat->i_infos; j++ )
491 if( !strcmp( p_cat->pp_infos[j]->psz_name, psz_name ) )
493 char *psz_ret = strdup( p_cat->pp_infos[j]->psz_value );
494 vlc_mutex_unlock( &p_i->lock );
499 vlc_mutex_unlock( &p_i->lock );
503 static int InputItemVaAddInfo( input_item_t *p_i,
505 const char *psz_name,
506 const char *psz_format, va_list args )
509 info_t *p_info = NULL;
510 info_category_t *p_cat = NULL ;
512 vlc_assert_locked( &p_i->lock );
514 for( i = 0 ; i < p_i->i_categories ; i ++ )
516 if( !strcmp( p_i->pp_categories[i]->psz_name, psz_cat ) )
518 p_cat = p_i->pp_categories[i];
524 if( !(p_cat = malloc( sizeof(*p_cat) )) )
527 p_cat->psz_name = strdup( psz_cat );
530 INSERT_ELEM( p_i->pp_categories, p_i->i_categories, p_i->i_categories,
534 for( i = 0; i< p_cat->i_infos; i++ )
536 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
538 p_info = p_cat->pp_infos[i];
545 if( ( p_info = malloc( sizeof( *p_info ) ) ) == NULL )
548 INSERT_ELEM( p_cat->pp_infos, p_cat->i_infos, p_cat->i_infos, p_info );
549 p_info->psz_name = strdup( psz_name );
553 free( p_info->psz_value );
556 if( vasprintf( &p_info->psz_value, psz_format, args ) == -1 )
557 p_info->psz_value = NULL;
559 return p_info->psz_value ? VLC_SUCCESS : VLC_ENOMEM;
562 static int InputItemAddInfo( input_item_t *p_i,
564 const char *psz_name,
565 const char *psz_format, ... )
569 va_start( args, psz_format );
570 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
576 int input_item_AddInfo( input_item_t *p_i,
578 const char *psz_name,
579 const char *psz_format, ... )
583 vlc_mutex_lock( &p_i->lock );
585 va_start( args, psz_format );
586 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
589 vlc_mutex_unlock( &p_i->lock );
596 event.type = vlc_InputItemInfoChanged;
597 vlc_event_send( &p_i->event_manager, &event );
602 int input_item_DelInfo( input_item_t *p_i,
604 const char *psz_name )
606 info_category_t *p_cat = NULL;
610 vlc_mutex_lock( &p_i->lock );
611 for( i_cat = 0; i_cat < p_i->i_categories; i_cat++ )
613 if( !strcmp( p_i->pp_categories[i_cat]->psz_name,
616 p_cat = p_i->pp_categories[i_cat];
622 vlc_mutex_unlock( &p_i->lock );
628 /* Remove a specific info */
629 for( i = 0; i < p_cat->i_infos; i++ )
631 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
633 free( p_cat->pp_infos[i]->psz_name );
634 free( p_cat->pp_infos[i]->psz_value );
635 free( p_cat->pp_infos[i] );
636 REMOVE_ELEM( p_cat->pp_infos, p_cat->i_infos, i );
640 if( i >= p_cat->i_infos )
642 vlc_mutex_unlock( &p_i->lock );
648 /* Remove the complete categorie */
649 for( i = 0; i < p_cat->i_infos; i++ )
651 free( p_cat->pp_infos[i]->psz_name );
652 free( p_cat->pp_infos[i]->psz_value );
653 free( p_cat->pp_infos[i] );
655 free( p_cat->pp_infos );
656 REMOVE_ELEM( p_i->pp_categories, p_i->i_categories, i_cat );
660 free( p_cat->psz_name );
662 vlc_mutex_unlock( &p_i->lock );
666 event.type = vlc_InputItemInfoChanged;
667 vlc_event_send( &p_i->event_manager, &event );
672 void input_item_SetEpg( input_item_t *p_item,
673 const char *psz_epg, const vlc_epg_t *p_epg )
675 input_item_DelInfo( p_item, psz_epg, NULL );
677 #ifdef HAVE_LOCALTIME_R
678 vlc_mutex_lock( &p_item->lock );
679 for( int i = 0; i < p_epg->i_event; i++ )
681 const vlc_epg_event_t *p_evt = p_epg->pp_event[i];
682 time_t t_start = (time_t)p_evt->i_start;
686 localtime_r( &t_start, &tm_start );
688 snprintf( psz_start, sizeof(psz_start), "%4.4d-%2.2d-%2.2d %2.2d:%2.2d:%2.2d",
689 1900 + tm_start.tm_year, 1 + tm_start.tm_mon, tm_start.tm_mday,
690 tm_start.tm_hour, tm_start.tm_min, tm_start.tm_sec );
691 if( p_evt->psz_short_description || p_evt->psz_description )
692 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d) - %s",
694 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60,
695 p_evt->psz_short_description ? p_evt->psz_short_description : p_evt->psz_description );
697 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d)",
699 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60 );
701 vlc_mutex_unlock( &p_item->lock );
703 if( p_epg->i_event > 0 )
707 event.type = vlc_InputItemInfoChanged;
708 vlc_event_send( &p_item->event_manager, &event );
714 input_item_t *__input_item_NewExt( vlc_object_t *p_obj, const char *psz_uri,
715 const char *psz_name,
717 const char *const *ppsz_options,
718 unsigned i_option_flags,
721 return input_item_NewWithType( p_obj, psz_uri, psz_name,
722 i_options, ppsz_options, i_option_flags,
723 i_duration, ITEM_TYPE_UNKNOWN );
727 input_item_t *input_item_NewWithType( vlc_object_t *p_obj, const char *psz_uri,
728 const char *psz_name,
730 const char *const *ppsz_options,
731 unsigned i_option_flags,
735 libvlc_priv_t *priv = libvlc_priv (p_obj->p_libvlc);
736 static vlc_mutex_t input_id_lock = VLC_STATIC_MUTEX;
738 input_item_t* p_input = malloc( sizeof(input_item_t ) );
742 input_item_Init( p_obj, p_input );
743 vlc_gc_init( p_input, input_item_Destroy );
745 vlc_mutex_lock( &input_id_lock );
746 p_input->i_id = ++priv->i_last_input_id;
747 vlc_mutex_unlock( &input_id_lock );
749 p_input->b_fixed_name = false;
751 p_input->i_type = i_type;
752 p_input->b_prefers_tree = false;
755 input_item_SetURI( p_input, psz_uri );
757 if( i_type != ITEM_TYPE_UNKNOWN )
758 p_input->i_type = i_type;
761 input_item_SetName( p_input, psz_name );
763 p_input->i_duration = i_duration;
765 for( int i = 0; i < i_options; i++ )
766 input_item_AddOption( p_input, ppsz_options[i], i_option_flags );
770 /* Guess the type of the item using the beginning of the mrl */
771 static void GuessType( input_item_t *p_item)
774 static struct { const char *psz_search; int i_type; } types_array[] =
776 { "http", ITEM_TYPE_NET },
777 { "dvd", ITEM_TYPE_DISC },
778 { "cdda", ITEM_TYPE_CDDA },
779 { "mms", ITEM_TYPE_NET },
780 { "rtsp", ITEM_TYPE_NET },
781 { "udp", ITEM_TYPE_NET },
782 { "rtp", ITEM_TYPE_NET },
783 { "vcd", ITEM_TYPE_DISC },
784 { "v4l", ITEM_TYPE_CARD },
785 { "dshow", ITEM_TYPE_CARD },
786 { "pvr", ITEM_TYPE_CARD },
787 { "dvb", ITEM_TYPE_CARD },
788 { "qpsk", ITEM_TYPE_CARD },
789 { "sdp", ITEM_TYPE_NET },
793 if( !p_item->psz_uri )
795 p_item->i_type = ITEM_TYPE_FILE;
799 for( i = 0; types_array[i].psz_search != NULL; i++ )
801 if( !strncmp( p_item->psz_uri, types_array[i].psz_search,
802 strlen( types_array[i].psz_search ) ) )
804 p_item->i_type = types_array[i].i_type;
808 p_item->i_type = ITEM_TYPE_FILE;