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 along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
29 #include <vlc_common.h>
31 #include "vlc_playlist.h"
32 #include "vlc_interface.h"
36 static void GuessType( input_item_t *p_item );
38 /** Stuff moved out of vlc_input.h -- FIXME: should probably not be inline
40 static inline void input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
42 memset( p_i, 0, sizeof(input_item_t) );
46 TAB_INIT( p_i->i_es, p_i->es );
47 TAB_INIT( p_i->i_options, p_i->ppsz_options );
48 p_i->optflagv = NULL, p_i->optflagc = 0;
49 TAB_INIT( p_i->i_categories, p_i->pp_categories );
51 p_i->i_type = ITEM_TYPE_UNKNOWN;
52 p_i->b_fixed_name = true;
57 vlc_mutex_init( &p_i->lock );
58 vlc_event_manager_t * p_em = &p_i->event_manager;
59 vlc_event_manager_init( p_em, p_i, p_o );
60 vlc_event_manager_register_event_type( p_em, vlc_InputItemMetaChanged );
61 vlc_event_manager_register_event_type( p_em, vlc_InputItemSubItemAdded );
62 vlc_event_manager_register_event_type( p_em, vlc_InputItemDurationChanged );
63 vlc_event_manager_register_event_type( p_em, vlc_InputItemPreparsedChanged );
64 vlc_event_manager_register_event_type( p_em, vlc_InputItemNameChanged );
65 vlc_event_manager_register_event_type( p_em, vlc_InputItemInfoChanged );
66 vlc_event_manager_register_event_type( p_em, vlc_InputItemErrorWhenReadingChanged );
69 static inline void input_item_Clean( input_item_t *p_i )
73 vlc_event_manager_fini( &p_i->event_manager );
75 free( p_i->psz_name );
79 vlc_mutex_destroy( &p_i->p_stats->lock );
84 vlc_meta_Delete( p_i->p_meta );
86 for( i = 0; i < p_i->i_options; i++ )
87 free( p_i->ppsz_options[i] );
88 TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
91 for( i = 0; i < p_i->i_es; i++ )
93 es_format_Clean( p_i->es[i] );
96 TAB_CLEAN( p_i->i_es, p_i->es );
98 for( i = 0; i < p_i->i_categories; i++ )
100 info_category_t *p_category = p_i->pp_categories[i];
103 for( j = 0; j < p_category->i_infos; j++ )
105 struct info_t *p_info = p_category->pp_infos[j];
107 free( p_info->psz_name);
108 free( p_info->psz_value );
111 TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
113 free( p_category->psz_name );
116 TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
118 vlc_mutex_destroy( &p_i->lock );
120 void input_item_SetErrorWhenReading( input_item_t *p_i, bool b_error )
124 vlc_mutex_lock( &p_i->lock );
126 b_changed = p_i->b_error_when_reading != b_error;
127 p_i->b_error_when_reading = b_error;
129 vlc_mutex_unlock( &p_i->lock );
135 event.type = vlc_InputItemErrorWhenReadingChanged;
136 event.u.input_item_error_when_reading_changed.new_value = b_error;
137 vlc_event_send( &p_i->event_manager, &event );
140 void input_item_SetPreparsed( input_item_t *p_i, bool b_preparsed )
142 bool b_send_event = false;
144 vlc_mutex_lock( &p_i->lock );
147 p_i->p_meta = vlc_meta_New();
151 i_new_status = p_i->p_meta->i_status | ITEM_PREPARSED;
153 i_new_status = p_i->p_meta->i_status & ~ITEM_PREPARSED;
154 if( p_i->p_meta->i_status != i_new_status )
156 p_i->p_meta->i_status = i_new_status;
160 vlc_mutex_unlock( &p_i->lock );
165 event.type = vlc_InputItemPreparsedChanged;
166 event.u.input_item_preparsed_changed.new_status = i_new_status;
167 vlc_event_send( &p_i->event_manager, &event );
170 void input_item_SetArtNotFound( input_item_t *p_i, bool b_not_found )
172 vlc_mutex_lock( &p_i->lock );
175 p_i->p_meta = vlc_meta_New();
178 p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
180 p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
182 vlc_mutex_unlock( &p_i->lock );
184 void input_item_SetArtFetched( input_item_t *p_i, bool b_art_fetched )
186 vlc_mutex_lock( &p_i->lock );
189 p_i->p_meta = vlc_meta_New();
192 p_i->p_meta->i_status |= ITEM_ART_FETCHED;
194 p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
196 vlc_mutex_unlock( &p_i->lock );
199 void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
203 vlc_mutex_lock( &p_i->lock );
205 p_i->p_meta = vlc_meta_New();
206 vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
207 vlc_mutex_unlock( &p_i->lock );
209 /* Notify interested third parties */
210 event.type = vlc_InputItemMetaChanged;
211 event.u.input_item_meta_changed.meta_type = meta_type;
212 vlc_event_send( &p_i->event_manager, &event );
215 /* FIXME GRRRRRRRRRR args should be in the reverse order to be
216 * consistant with (nearly?) all or copy funcs */
217 void input_item_CopyOptions( input_item_t *p_parent,
218 input_item_t *p_child )
220 vlc_mutex_lock( &p_parent->lock );
222 for( int i = 0 ; i< p_parent->i_options; i++ )
224 if( !strcmp( p_parent->ppsz_options[i], "meta-file" ) )
227 input_item_AddOption( p_child,
228 p_parent->ppsz_options[i],
229 p_parent->optflagv[i] );
232 vlc_mutex_unlock( &p_parent->lock );
235 /* This won't hold the item, but can tell to interested third parties
236 * Like the playlist, that there is a new sub item. With this design
237 * It is not the input item's responsability to keep all the ref of
238 * the input item children. */
239 void input_item_AddSubItem( input_item_t *p_parent, input_item_t *p_child )
241 vlc_mutex_lock( &p_parent->lock );
243 p_parent->i_type = ITEM_TYPE_PLAYLIST;
245 vlc_mutex_unlock( &p_parent->lock );
247 /* Notify interested third parties */
250 event.type = vlc_InputItemSubItemAdded;
251 event.u.input_item_subitem_added.p_new_child = p_child;
252 vlc_event_send( &p_parent->event_manager, &event );
255 bool input_item_HasErrorWhenReading( input_item_t *p_item )
257 vlc_mutex_lock( &p_item->lock );
259 bool b_error = p_item->b_error_when_reading;
261 vlc_mutex_unlock( &p_item->lock );
266 bool input_item_MetaMatch( input_item_t *p_i,
267 vlc_meta_type_t meta_type, const char *psz )
269 vlc_mutex_lock( &p_i->lock );
273 vlc_mutex_unlock( &p_i->lock );
276 const char *psz_meta = vlc_meta_Get( p_i->p_meta, meta_type );
277 bool b_ret = psz_meta && strcasestr( psz_meta, psz );
279 vlc_mutex_unlock( &p_i->lock );
284 char *input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
286 vlc_mutex_lock( &p_i->lock );
290 vlc_mutex_unlock( &p_i->lock );
295 if( vlc_meta_Get( p_i->p_meta, meta_type ) )
296 psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
298 vlc_mutex_unlock( &p_i->lock );
302 /* Get the title of a given item or fallback to the name if the title is empty */
303 char *input_item_GetTitleFbName( input_item_t *p_item )
306 vlc_mutex_lock( &p_item->lock );
308 if( !p_item->p_meta )
310 psz_ret = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
311 vlc_mutex_unlock( &p_item->lock );
315 const char *psz_title = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
316 if( !EMPTY_STR( psz_title ) )
317 psz_ret = strdup( psz_title );
319 psz_ret = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
321 vlc_mutex_unlock( &p_item->lock );
325 char *input_item_GetName( input_item_t *p_item )
327 vlc_mutex_lock( &p_item->lock );
329 char *psz_name = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
331 vlc_mutex_unlock( &p_item->lock );
334 void input_item_SetName( input_item_t *p_item, const char *psz_name )
336 vlc_mutex_lock( &p_item->lock );
338 free( p_item->psz_name );
339 p_item->psz_name = strdup( psz_name );
341 vlc_mutex_unlock( &p_item->lock );
344 char *input_item_GetURI( input_item_t *p_i )
346 vlc_mutex_lock( &p_i->lock );
348 char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
350 vlc_mutex_unlock( &p_i->lock );
353 void input_item_SetURI( input_item_t *p_i, const char *psz_uri )
355 vlc_mutex_lock( &p_i->lock );
357 free( p_i->psz_uri );
358 p_i->psz_uri = strdup( psz_uri );
362 if( !p_i->psz_name && p_i->i_type == ITEM_TYPE_FILE )
364 const char *psz_filename = strrchr( p_i->psz_uri, DIR_SEP_CHAR );
365 if( psz_filename && *psz_filename == DIR_SEP_CHAR )
367 if( psz_filename && *psz_filename )
368 p_i->psz_name = strdup( psz_filename );
371 /* The name is NULL: fill it with everything except login and password */
376 vlc_UrlParse( &url, psz_uri, 0 );
377 if( url.psz_protocol )
380 r=asprintf( &p_i->psz_name, "%s://%s:%d%s", url.psz_protocol,
381 url.psz_host, url.i_port,
382 url.psz_path ? url.psz_path : "" );
384 r=asprintf( &p_i->psz_name, "%s://%s%s", url.psz_protocol,
385 url.psz_host ? url.psz_host : "",
386 url.psz_path ? url.psz_path : "" );
391 r=asprintf( &p_i->psz_name, "%s:%d%s", url.psz_host, url.i_port,
392 url.psz_path ? url.psz_path : "" );
394 r=asprintf( &p_i->psz_name, "%s%s", url.psz_host,
395 url.psz_path ? url.psz_path : "" );
397 vlc_UrlClean( &url );
399 p_i->psz_name=NULL; /* recover from undefined value */
402 vlc_mutex_unlock( &p_i->lock );
405 mtime_t input_item_GetDuration( input_item_t *p_i )
407 vlc_mutex_lock( &p_i->lock );
409 mtime_t i_duration = p_i->i_duration;
411 vlc_mutex_unlock( &p_i->lock );
415 void input_item_SetDuration( input_item_t *p_i, mtime_t i_duration )
417 bool b_send_event = false;
419 vlc_mutex_lock( &p_i->lock );
420 if( p_i->i_duration != i_duration )
422 p_i->i_duration = i_duration;
425 vlc_mutex_unlock( &p_i->lock );
431 event.type = vlc_InputItemDurationChanged;
432 event.u.input_item_duration_changed.new_duration = i_duration;
433 vlc_event_send( &p_i->event_manager, &event );
438 bool input_item_IsPreparsed( input_item_t *p_item )
440 vlc_mutex_lock( &p_item->lock );
441 bool b_preparsed = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_PREPARSED ) != 0 : false;
442 vlc_mutex_unlock( &p_item->lock );
447 bool input_item_IsArtFetched( input_item_t *p_item )
449 vlc_mutex_lock( &p_item->lock );
450 bool b_fetched = p_item->p_meta ? ( p_item->p_meta->i_status & ITEM_ART_FETCHED ) != 0 : false;
451 vlc_mutex_unlock( &p_item->lock );
456 static void input_item_Destroy ( gc_object_t *p_gc )
458 input_item_t *p_item = vlc_priv( p_gc, input_item_t );
460 input_item_Clean( p_item );
464 int input_item_AddOption( input_item_t *p_input, const char *psz_option,
467 int err = VLC_SUCCESS;
469 if( psz_option == NULL )
472 vlc_mutex_lock( &p_input->lock );
473 if (flags & VLC_INPUT_OPTION_UNIQUE)
475 for (int i = 0 ; i < p_input->i_options; i++)
476 if( !strcmp( p_input->ppsz_options[i], psz_option ) )
480 uint8_t *flagv = realloc (p_input->optflagv, p_input->optflagc + 1);
486 p_input->optflagv = flagv;
487 flagv[p_input->optflagc++] = flags;
489 INSERT_ELEM( p_input->ppsz_options, p_input->i_options,
490 p_input->i_options, strdup( psz_option ) );
492 vlc_mutex_unlock( &p_input->lock );
497 * Get a info item from a given category in a given input item.
499 * \param p_i The input item to get info from
500 * \param psz_cat String representing the category for the info
501 * \param psz_name String representing the name of the desired info
502 * \return A pointer to the string with the given info if found, or an
503 * empty string otherwise. The caller should free the returned
506 char *input_item_GetInfo( input_item_t *p_i,
508 const char *psz_name )
510 vlc_mutex_lock( &p_i->lock );
512 for( int i = 0; i< p_i->i_categories; i++ )
514 const info_category_t *p_cat = p_i->pp_categories[i];
516 if( !psz_cat || strcmp( p_cat->psz_name, psz_cat ) )
519 for( int j = 0; j < p_cat->i_infos; j++ )
521 if( !strcmp( p_cat->pp_infos[j]->psz_name, psz_name ) )
523 char *psz_ret = strdup( p_cat->pp_infos[j]->psz_value );
524 vlc_mutex_unlock( &p_i->lock );
529 vlc_mutex_unlock( &p_i->lock );
533 static int InputItemVaAddInfo( input_item_t *p_i,
535 const char *psz_name,
536 const char *psz_format, va_list args )
539 info_t *p_info = NULL;
540 info_category_t *p_cat = NULL ;
542 vlc_assert_locked( &p_i->lock );
544 for( i = 0 ; i < p_i->i_categories ; i ++ )
546 if( !strcmp( p_i->pp_categories[i]->psz_name, psz_cat ) )
548 p_cat = p_i->pp_categories[i];
554 if( !(p_cat = malloc( sizeof(*p_cat) )) )
557 p_cat->psz_name = strdup( psz_cat );
560 INSERT_ELEM( p_i->pp_categories, p_i->i_categories, p_i->i_categories,
564 for( i = 0; i< p_cat->i_infos; i++ )
566 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
568 p_info = p_cat->pp_infos[i];
575 if( ( p_info = malloc( sizeof( *p_info ) ) ) == NULL )
578 INSERT_ELEM( p_cat->pp_infos, p_cat->i_infos, p_cat->i_infos, p_info );
579 p_info->psz_name = strdup( psz_name );
583 free( p_info->psz_value );
586 if( vasprintf( &p_info->psz_value, psz_format, args ) == -1 )
587 p_info->psz_value = NULL;
589 return p_info->psz_value ? VLC_SUCCESS : VLC_ENOMEM;
592 static int InputItemAddInfo( input_item_t *p_i,
594 const char *psz_name,
595 const char *psz_format, ... )
599 va_start( args, psz_format );
600 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
606 int input_item_AddInfo( input_item_t *p_i,
608 const char *psz_name,
609 const char *psz_format, ... )
613 vlc_mutex_lock( &p_i->lock );
615 va_start( args, psz_format );
616 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
619 vlc_mutex_unlock( &p_i->lock );
626 event.type = vlc_InputItemInfoChanged;
627 vlc_event_send( &p_i->event_manager, &event );
632 int input_item_DelInfo( input_item_t *p_i,
634 const char *psz_name )
636 info_category_t *p_cat = NULL;
640 vlc_mutex_lock( &p_i->lock );
641 for( i_cat = 0; i_cat < p_i->i_categories; i_cat++ )
643 if( !strcmp( p_i->pp_categories[i_cat]->psz_name,
646 p_cat = p_i->pp_categories[i_cat];
652 vlc_mutex_unlock( &p_i->lock );
658 /* Remove a specific info */
659 for( i = 0; i < p_cat->i_infos; i++ )
661 if( !strcmp( p_cat->pp_infos[i]->psz_name, psz_name ) )
663 free( p_cat->pp_infos[i]->psz_name );
664 free( p_cat->pp_infos[i]->psz_value );
665 free( p_cat->pp_infos[i] );
666 REMOVE_ELEM( p_cat->pp_infos, p_cat->i_infos, i );
670 if( i >= p_cat->i_infos )
672 vlc_mutex_unlock( &p_i->lock );
678 /* Remove the complete categorie */
679 for( i = 0; i < p_cat->i_infos; i++ )
681 free( p_cat->pp_infos[i]->psz_name );
682 free( p_cat->pp_infos[i]->psz_value );
683 free( p_cat->pp_infos[i] );
685 free( p_cat->pp_infos );
686 REMOVE_ELEM( p_i->pp_categories, p_i->i_categories, i_cat );
690 free( p_cat->psz_name );
692 vlc_mutex_unlock( &p_i->lock );
696 event.type = vlc_InputItemInfoChanged;
697 vlc_event_send( &p_i->event_manager, &event );
702 void input_item_SetEpg( input_item_t *p_item,
703 const char *psz_epg, const vlc_epg_t *p_epg )
705 input_item_DelInfo( p_item, psz_epg, NULL );
707 #ifdef HAVE_LOCALTIME_R
708 vlc_mutex_lock( &p_item->lock );
709 for( int i = 0; i < p_epg->i_event; i++ )
711 const vlc_epg_event_t *p_evt = p_epg->pp_event[i];
712 time_t t_start = (time_t)p_evt->i_start;
716 localtime_r( &t_start, &tm_start );
718 snprintf( psz_start, sizeof(psz_start), "%4.4d-%2.2d-%2.2d %2.2d:%2.2d:%2.2d",
719 1900 + tm_start.tm_year, 1 + tm_start.tm_mon, tm_start.tm_mday,
720 tm_start.tm_hour, tm_start.tm_min, tm_start.tm_sec );
721 if( p_evt->psz_short_description || p_evt->psz_description )
722 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d) - %s",
724 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60,
725 p_evt->psz_short_description ? p_evt->psz_short_description : p_evt->psz_description );
727 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d)",
729 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60 );
731 vlc_mutex_unlock( &p_item->lock );
733 if( p_epg->i_event > 0 )
737 event.type = vlc_InputItemInfoChanged;
738 vlc_event_send( &p_item->event_manager, &event );
744 input_item_t *__input_item_NewExt( vlc_object_t *p_obj, const char *psz_uri,
745 const char *psz_name,
747 const char *const *ppsz_options,
748 unsigned i_option_flags,
751 return input_item_NewWithType( p_obj, psz_uri, psz_name,
752 i_options, ppsz_options, i_option_flags,
753 i_duration, ITEM_TYPE_UNKNOWN );
757 input_item_t *input_item_NewWithType( vlc_object_t *p_obj, const char *psz_uri,
758 const char *psz_name,
760 const char *const *ppsz_options,
761 unsigned i_option_flags,
765 libvlc_priv_t *priv = libvlc_priv (p_obj->p_libvlc);
766 static vlc_mutex_t input_id_lock = VLC_STATIC_MUTEX;
768 input_item_t* p_input = malloc( sizeof(input_item_t ) );
772 input_item_Init( p_obj, p_input );
773 vlc_gc_init( p_input, input_item_Destroy );
775 vlc_mutex_lock( &input_id_lock );
776 p_input->i_id = ++priv->i_last_input_id;
777 vlc_mutex_unlock( &input_id_lock );
779 p_input->b_fixed_name = false;
781 p_input->i_type = i_type;
782 p_input->b_prefers_tree = false;
785 input_item_SetURI( p_input, psz_uri );
787 if( i_type != ITEM_TYPE_UNKNOWN )
788 p_input->i_type = i_type;
791 input_item_SetName( p_input, psz_name );
793 p_input->i_duration = i_duration;
795 for( int i = 0; i < i_options; i++ )
796 input_item_AddOption( p_input, ppsz_options[i], i_option_flags );
800 /* Guess the type of the item using the beginning of the mrl */
801 static void GuessType( input_item_t *p_item)
804 static struct { const char *psz_search; int i_type; } types_array[] =
806 { "http", ITEM_TYPE_NET },
807 { "dvd", ITEM_TYPE_DISC },
808 { "cdda", ITEM_TYPE_CDDA },
809 { "mms", ITEM_TYPE_NET },
810 { "rtsp", ITEM_TYPE_NET },
811 { "udp", ITEM_TYPE_NET },
812 { "rtp", ITEM_TYPE_NET },
813 { "vcd", ITEM_TYPE_DISC },
814 { "v4l", ITEM_TYPE_CARD },
815 { "dshow", ITEM_TYPE_CARD },
816 { "pvr", ITEM_TYPE_CARD },
817 { "dvb", ITEM_TYPE_CARD },
818 { "qpsk", ITEM_TYPE_CARD },
819 { "sdp", ITEM_TYPE_NET },
820 { "ftp", ITEM_TYPE_NET },
821 { "smb", ITEM_TYPE_NET },
825 if( !p_item->psz_uri || !strstr( p_item->psz_uri, "://" ) )
827 p_item->i_type = ITEM_TYPE_FILE;
831 for( i = 0; types_array[i].psz_search != NULL; i++ )
833 if( !strncmp( p_item->psz_uri, types_array[i].psz_search,
834 strlen( types_array[i].psz_search ) ) )
836 p_item->i_type = types_array[i].i_type;
840 p_item->i_type = ITEM_TYPE_FILE;