codec/esout: add support for CEA708
[vlc.git] / src / input / item.c
blob0327e21f0397be3cf80f48bb2d9a013690d39d04
1 /*****************************************************************************
2 * item.c: input_item management
3 *****************************************************************************
4 * Copyright (C) 1998-2004 VLC authors and VideoLAN
5 * $Id$
7 * Authors: Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27 #include <assert.h>
28 #include <time.h>
29 #include <limits.h>
30 #include <ctype.h>
32 #include <vlc_common.h>
33 #include <vlc_url.h>
34 #include <vlc_interface.h>
35 #include <vlc_charset.h>
36 #include <vlc_strings.h>
38 #include "item.h"
39 #include "info.h"
40 #include "input_internal.h"
42 struct input_item_opaque
44 struct input_item_opaque *next;
45 void *value;
46 char name[1];
49 static int GuessType( const input_item_t *p_item, bool *p_net );
51 void input_item_SetErrorWhenReading( input_item_t *p_i, bool b_error )
53 bool b_changed;
55 vlc_mutex_lock( &p_i->lock );
57 b_changed = p_i->b_error_when_reading != b_error;
58 p_i->b_error_when_reading = b_error;
60 vlc_mutex_unlock( &p_i->lock );
62 if( b_changed )
64 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
65 .type = vlc_InputItemErrorWhenReadingChanged,
66 .u.input_item_error_when_reading_changed.new_value = b_error } );
69 void input_item_SignalPreparseEnded( input_item_t *p_i, int status )
71 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
72 .type = vlc_InputItemPreparseEnded,
73 .u.input_item_preparse_ended.new_status = status } );
76 void input_item_SetPreparsed( input_item_t *p_i, bool b_preparsed )
78 bool b_send_event = false;
80 vlc_mutex_lock( &p_i->lock );
82 if( !p_i->p_meta )
83 p_i->p_meta = vlc_meta_New();
85 int status = vlc_meta_GetStatus(p_i->p_meta);
86 int new_status;
87 if( b_preparsed )
88 new_status = status | ITEM_PREPARSED;
89 else
90 new_status = status & ~ITEM_PREPARSED;
91 if( status != new_status )
93 vlc_meta_SetStatus(p_i->p_meta, new_status);
94 b_send_event = true;
97 vlc_mutex_unlock( &p_i->lock );
99 if( b_send_event )
101 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
102 .type = vlc_InputItemPreparsedChanged,
103 .u.input_item_preparsed_changed.new_status = new_status } );
107 void input_item_SetArtNotFound( input_item_t *p_i, bool b_not_found )
109 vlc_mutex_lock( &p_i->lock );
111 if( !p_i->p_meta )
112 p_i->p_meta = vlc_meta_New();
114 int status = vlc_meta_GetStatus(p_i->p_meta);
116 if( b_not_found )
117 status |= ITEM_ART_NOTFOUND;
118 else
119 status &= ~ITEM_ART_NOTFOUND;
121 vlc_meta_SetStatus(p_i->p_meta, status);
123 vlc_mutex_unlock( &p_i->lock );
126 void input_item_SetArtFetched( input_item_t *p_i, bool b_art_fetched )
128 vlc_mutex_lock( &p_i->lock );
130 if( !p_i->p_meta )
131 p_i->p_meta = vlc_meta_New();
133 int status = vlc_meta_GetStatus(p_i->p_meta);
135 if( b_art_fetched )
136 status |= ITEM_ART_FETCHED;
137 else
138 status &= ~ITEM_ART_FETCHED;
140 vlc_meta_SetStatus(p_i->p_meta, status);
142 vlc_mutex_unlock( &p_i->lock );
145 void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
147 vlc_mutex_lock( &p_i->lock );
148 if( !p_i->p_meta )
149 p_i->p_meta = vlc_meta_New();
150 vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
151 vlc_mutex_unlock( &p_i->lock );
153 /* Notify interested third parties */
154 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
155 .type = vlc_InputItemMetaChanged,
156 .u.input_item_meta_changed.meta_type = meta_type } );
159 void input_item_CopyOptions( input_item_t *p_child,
160 input_item_t *p_parent )
162 char **optv = NULL;
163 uint8_t *flagv = NULL;
164 int optc = 0;
165 char **optv_realloc = NULL;
166 uint8_t *flagv_realloc = NULL;
168 vlc_mutex_lock( &p_parent->lock );
170 if( p_parent->i_options > 0 )
172 optv = malloc( p_parent->i_options * sizeof (*optv) );
173 if( likely(optv) )
174 flagv = malloc( p_parent->i_options * sizeof (*flagv) );
176 if( likely(flagv) )
178 for( int i = 0; i < p_parent->i_options; i++ )
180 char *psz_dup = strdup( p_parent->ppsz_options[i] );
181 if( likely(psz_dup) )
183 flagv[optc] = p_parent->optflagv[i];
184 optv[optc++] = psz_dup;
190 vlc_mutex_unlock( &p_parent->lock );
192 if( likely(optv && flagv && optc ) )
194 vlc_mutex_lock( &p_child->lock );
196 if( INT_MAX - p_child->i_options >= optc &&
197 SIZE_MAX / sizeof (*flagv) >= (size_t) (p_child->i_options + optc) )
198 flagv_realloc = realloc( p_child->optflagv,
199 (p_child->i_options + optc) * sizeof (*flagv) );
200 if( likely(flagv_realloc) )
202 p_child->optflagv = flagv_realloc;
203 if( SIZE_MAX / sizeof (*optv) >= (size_t) (p_child->i_options + optc) )
204 optv_realloc = realloc( p_child->ppsz_options,
205 (p_child->i_options + optc) * sizeof (*optv) );
206 if( likely(optv_realloc) )
208 p_child->ppsz_options = optv_realloc;
209 memcpy( p_child->ppsz_options + p_child->i_options, optv,
210 optc * sizeof (*optv) );
211 memcpy( p_child->optflagv + p_child->i_options, flagv,
212 optc * sizeof (*flagv) );
213 p_child->i_options += optc;
214 p_child->optflagc += optc;
218 vlc_mutex_unlock( &p_child->lock );
221 if( unlikely(!flagv_realloc || !optv_realloc) )
223 /* Didn't copy pointers, so need to free the strdup() */
224 for( int i=0; i<optc; i++ )
225 free( optv[i] );
228 free( flagv );
229 free( optv );
232 bool input_item_HasErrorWhenReading( input_item_t *p_item )
234 vlc_mutex_lock( &p_item->lock );
236 bool b_error = p_item->b_error_when_reading;
238 vlc_mutex_unlock( &p_item->lock );
240 return b_error;
243 bool input_item_MetaMatch( input_item_t *p_i,
244 vlc_meta_type_t meta_type, const char *psz )
246 vlc_mutex_lock( &p_i->lock );
248 if( !p_i->p_meta )
250 vlc_mutex_unlock( &p_i->lock );
251 return false;
253 const char *psz_meta = vlc_meta_Get( p_i->p_meta, meta_type );
254 bool b_ret = psz_meta && strcasestr( psz_meta, psz );
256 vlc_mutex_unlock( &p_i->lock );
258 return b_ret;
261 char *input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
263 vlc_mutex_lock( &p_i->lock );
265 if( !p_i->p_meta )
267 vlc_mutex_unlock( &p_i->lock );
268 return NULL;
271 char *psz = NULL;
272 if( vlc_meta_Get( p_i->p_meta, meta_type ) )
273 psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
275 vlc_mutex_unlock( &p_i->lock );
276 return psz;
279 /* Get the title of a given item or fallback to the name if the title is empty */
280 char *input_item_GetTitleFbName( input_item_t *p_item )
282 char *psz_ret;
283 vlc_mutex_lock( &p_item->lock );
285 if( !p_item->p_meta )
287 psz_ret = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
288 vlc_mutex_unlock( &p_item->lock );
289 return psz_ret;
292 const char *psz_title = vlc_meta_Get( p_item->p_meta, vlc_meta_Title );
293 if( !EMPTY_STR( psz_title ) )
294 psz_ret = strdup( psz_title );
295 else
296 psz_ret = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
298 vlc_mutex_unlock( &p_item->lock );
299 return psz_ret;
302 char *input_item_GetName( input_item_t *p_item )
304 vlc_mutex_lock( &p_item->lock );
306 char *psz_name = p_item->psz_name ? strdup( p_item->psz_name ) : NULL;
308 vlc_mutex_unlock( &p_item->lock );
309 return psz_name;
311 void input_item_SetName( input_item_t *p_item, const char *psz_name )
313 vlc_mutex_lock( &p_item->lock );
315 free( p_item->psz_name );
316 p_item->psz_name = strdup( psz_name );
318 vlc_mutex_unlock( &p_item->lock );
321 char *input_item_GetURI( input_item_t *p_i )
323 vlc_mutex_lock( &p_i->lock );
325 char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
327 vlc_mutex_unlock( &p_i->lock );
328 return psz_s;
331 void input_item_SetURI( input_item_t *p_i, const char *psz_uri )
333 assert( psz_uri );
334 #ifndef NDEBUG
335 if( !strstr( psz_uri, "://" )
336 || strchr( psz_uri, ' ' ) || strchr( psz_uri, '"' ) )
337 fprintf( stderr, "Warning: %s(\"%s\"): file path instead of URL.\n",
338 __func__, psz_uri );
339 #endif
340 vlc_mutex_lock( &p_i->lock );
341 free( p_i->psz_uri );
342 p_i->psz_uri = strdup( psz_uri );
344 p_i->i_type = GuessType( p_i, &p_i->b_net );
346 if( p_i->psz_name )
348 else
349 if( p_i->i_type == ITEM_TYPE_FILE || p_i->i_type == ITEM_TYPE_DIRECTORY )
351 const char *psz_filename = strrchr( p_i->psz_uri, '/' );
353 if( psz_filename && *psz_filename == '/' )
354 psz_filename++;
355 if( psz_filename && *psz_filename )
356 p_i->psz_name = strdup( psz_filename );
358 /* Make the name more readable */
359 if( p_i->psz_name )
361 vlc_uri_decode( p_i->psz_name );
362 EnsureUTF8( p_i->psz_name );
365 else
366 { /* Strip login and password from title */
367 int r;
368 vlc_url_t url;
370 vlc_UrlParse( &url, psz_uri );
371 if( url.psz_protocol )
373 if( url.i_port > 0 )
374 r=asprintf( &p_i->psz_name, "%s://%s:%d%s", url.psz_protocol,
375 url.psz_host, url.i_port,
376 url.psz_path ? url.psz_path : "" );
377 else
378 r=asprintf( &p_i->psz_name, "%s://%s%s", url.psz_protocol,
379 url.psz_host ? url.psz_host : "",
380 url.psz_path ? url.psz_path : "" );
382 else
384 if( url.i_port > 0 )
385 r=asprintf( &p_i->psz_name, "%s:%d%s", url.psz_host, url.i_port,
386 url.psz_path ? url.psz_path : "" );
387 else
388 r=asprintf( &p_i->psz_name, "%s%s", url.psz_host,
389 url.psz_path ? url.psz_path : "" );
391 vlc_UrlClean( &url );
392 if( -1==r )
393 p_i->psz_name=NULL; /* recover from undefined value */
396 vlc_mutex_unlock( &p_i->lock );
399 mtime_t input_item_GetDuration( input_item_t *p_i )
401 vlc_mutex_lock( &p_i->lock );
403 mtime_t i_duration = p_i->i_duration;
405 vlc_mutex_unlock( &p_i->lock );
406 return i_duration;
409 void input_item_SetDuration( input_item_t *p_i, mtime_t i_duration )
411 bool b_send_event = false;
413 vlc_mutex_lock( &p_i->lock );
414 if( p_i->i_duration != i_duration )
416 p_i->i_duration = i_duration;
417 b_send_event = true;
419 vlc_mutex_unlock( &p_i->lock );
421 if( b_send_event )
423 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
424 .type = vlc_InputItemDurationChanged,
425 .u.input_item_duration_changed.new_duration = i_duration } );
429 char *input_item_GetNowPlayingFb( input_item_t *p_item )
431 char *psz_meta = input_item_GetMeta( p_item, vlc_meta_NowPlaying );
432 if( !psz_meta || strlen( psz_meta ) == 0 )
434 free( psz_meta );
435 return input_item_GetMeta( p_item, vlc_meta_ESNowPlaying );
438 return psz_meta;
441 bool input_item_IsPreparsed( input_item_t *p_item )
443 vlc_mutex_lock( &p_item->lock );
444 bool b_preparsed = p_item->p_meta ? ( vlc_meta_GetStatus(p_item->p_meta) & ITEM_PREPARSED ) != 0 : false;
445 vlc_mutex_unlock( &p_item->lock );
447 return b_preparsed;
450 bool input_item_IsArtFetched( input_item_t *p_item )
452 vlc_mutex_lock( &p_item->lock );
453 bool b_fetched = p_item->p_meta ? ( vlc_meta_GetStatus(p_item->p_meta) & ITEM_ART_FETCHED ) != 0 : false;
454 vlc_mutex_unlock( &p_item->lock );
456 return b_fetched;
459 bool input_item_ShouldPreparseSubItems( input_item_t *p_item )
461 bool b_ret;
463 vlc_mutex_lock( &p_item->lock );
464 b_ret = p_item->i_preparse_depth == -1 ? true : p_item->i_preparse_depth > 0;
465 vlc_mutex_unlock( &p_item->lock );
467 return b_ret;
470 input_item_t *input_item_Hold( input_item_t *p_item )
472 input_item_owner_t *owner = item_owner(p_item);
474 atomic_fetch_add( &owner->refs, 1 );
475 return p_item;
478 void input_item_Release( input_item_t *p_item )
480 input_item_owner_t *owner = item_owner(p_item);
482 if( atomic_fetch_sub(&owner->refs, 1) != 1 )
483 return;
485 vlc_event_manager_fini( &p_item->event_manager );
487 free( p_item->psz_name );
488 free( p_item->psz_uri );
489 if( p_item->p_stats != NULL )
491 vlc_mutex_destroy( &p_item->p_stats->lock );
492 free( p_item->p_stats );
495 if( p_item->p_meta != NULL )
496 vlc_meta_Delete( p_item->p_meta );
498 for( input_item_opaque_t *o = p_item->opaques, *next; o != NULL; o = next )
500 next = o->next;
501 free( o );
504 for( int i = 0; i < p_item->i_options; i++ )
505 free( p_item->ppsz_options[i] );
506 TAB_CLEAN( p_item->i_options, p_item->ppsz_options );
507 free( p_item->optflagv );
509 for( int i = 0; i < p_item->i_es; i++ )
511 es_format_Clean( p_item->es[i] );
512 free( p_item->es[i] );
514 TAB_CLEAN( p_item->i_es, p_item->es );
516 for( int i = 0; i < p_item->i_epg; i++ )
517 vlc_epg_Delete( p_item->pp_epg[i] );
518 TAB_CLEAN( p_item->i_epg, p_item->pp_epg );
520 for( int i = 0; i < p_item->i_categories; i++ )
521 info_category_Delete( p_item->pp_categories[i] );
522 TAB_CLEAN( p_item->i_categories, p_item->pp_categories );
524 for( int i = 0; i < p_item->i_slaves; i++ )
525 input_item_slave_Delete( p_item->pp_slaves[i] );
526 TAB_CLEAN( p_item->i_slaves, p_item->pp_slaves );
528 vlc_mutex_destroy( &p_item->lock );
529 free( owner );
532 int input_item_AddOption( input_item_t *p_input, const char *psz_option,
533 unsigned flags )
535 int err = VLC_SUCCESS;
537 if( psz_option == NULL )
538 return VLC_EGENERIC;
540 vlc_mutex_lock( &p_input->lock );
541 if (flags & VLC_INPUT_OPTION_UNIQUE)
543 for (int i = 0 ; i < p_input->i_options; i++)
544 if( !strcmp( p_input->ppsz_options[i], psz_option ) )
545 goto out;
548 uint8_t *flagv = realloc (p_input->optflagv, p_input->optflagc + 1);
549 if (flagv == NULL)
551 err = VLC_ENOMEM;
552 goto out;
555 p_input->optflagv = flagv;
557 char* psz_option_dup = strdup( psz_option );
558 if( unlikely( !psz_option_dup ) )
560 err = VLC_ENOMEM;
561 goto out;
564 TAB_APPEND(p_input->i_options, p_input->ppsz_options, psz_option_dup);
566 flagv[p_input->optflagc++] = flags;
568 out:
569 vlc_mutex_unlock( &p_input->lock );
570 return err;
573 int input_item_AddOptions( input_item_t *p_item, int i_options,
574 const char *const *ppsz_options,
575 unsigned i_flags )
577 int i_ret = VLC_SUCCESS;
578 for( int i = 0; i < i_options && i_ret == VLC_SUCCESS; i++ )
579 i_ret = input_item_AddOption( p_item, ppsz_options[i], i_flags );
580 return i_ret;
583 int input_item_AddOpaque(input_item_t *item, const char *name, void *value)
585 assert(name != NULL);
587 size_t namelen = strlen(name);
588 input_item_opaque_t *entry = malloc(sizeof (*entry) + namelen);
589 if (unlikely(entry == NULL))
590 return VLC_ENOMEM;
592 memcpy(entry->name, name, namelen + 1);
593 entry->value = value;
595 vlc_mutex_lock(&item->lock);
596 entry->next = item->opaques;
597 item->opaques = entry;
598 vlc_mutex_unlock(&item->lock);
599 return VLC_SUCCESS;
602 void input_item_ApplyOptions(vlc_object_t *obj, input_item_t *item)
604 vlc_mutex_lock(&item->lock);
605 assert(item->optflagc == (unsigned)item->i_options);
607 for (unsigned i = 0; i < (unsigned)item->i_options; i++)
608 var_OptionParse(obj, item->ppsz_options[i],
609 !!(item->optflagv[i] & VLC_INPUT_OPTION_TRUSTED));
611 for (const input_item_opaque_t *o = item->opaques; o != NULL; o = o->next)
613 var_Create(obj, o->name, VLC_VAR_ADDRESS);
614 var_SetAddress(obj, o->name, o->value);
617 vlc_mutex_unlock(&item->lock);
620 bool input_item_slave_GetType(const char *psz_filename,
621 enum slave_type *p_slave_type)
623 static const char *const ppsz_sub_exts[] = { SLAVE_SPU_EXTENSIONS, NULL };
624 static const char *const ppsz_audio_exts[] = { SLAVE_AUDIO_EXTENSIONS, NULL };
626 static struct {
627 enum slave_type i_type;
628 const char *const *ppsz_exts;
629 } p_slave_list[] = {
630 { SLAVE_TYPE_SPU, ppsz_sub_exts },
631 { SLAVE_TYPE_AUDIO, ppsz_audio_exts },
634 const char *psz_ext = strrchr(psz_filename, '.');
635 if (psz_ext == NULL || *(++psz_ext) == '\0')
636 return false;
638 for (unsigned int i = 0; i < sizeof(p_slave_list) / sizeof(*p_slave_list); ++i)
640 for (const char *const *ppsz_slave_ext = p_slave_list[i].ppsz_exts;
641 *ppsz_slave_ext != NULL; ppsz_slave_ext++)
643 if (!strcasecmp(psz_ext, *ppsz_slave_ext))
645 *p_slave_type = p_slave_list[i].i_type;
646 return true;
650 return false;
653 input_item_slave_t *input_item_slave_New(const char *psz_uri, enum slave_type i_type,
654 enum slave_priority i_priority)
656 if( !psz_uri )
657 return NULL;
659 input_item_slave_t *p_slave = malloc( sizeof( *p_slave ) + strlen( psz_uri ) + 1 );
660 if( !p_slave )
661 return NULL;
663 p_slave->i_type = i_type;
664 p_slave->i_priority = i_priority;
665 p_slave->b_forced = false;
666 strcpy( p_slave->psz_uri, psz_uri );
668 return p_slave;
671 int input_item_AddSlave(input_item_t *p_item, input_item_slave_t *p_slave)
673 if( p_item == NULL || p_slave == NULL
674 || p_slave->i_priority < SLAVE_PRIORITY_MATCH_NONE )
675 return VLC_EGENERIC;
677 vlc_mutex_lock( &p_item->lock );
679 TAB_APPEND(p_item->i_slaves, p_item->pp_slaves, p_slave);
681 vlc_mutex_unlock( &p_item->lock );
682 return VLC_SUCCESS;
685 static info_category_t *InputItemFindCat( input_item_t *p_item,
686 int *pi_index, const char *psz_cat )
688 vlc_assert_locked( &p_item->lock );
689 for( int i = 0; i < p_item->i_categories && psz_cat; i++ )
691 info_category_t *p_cat = p_item->pp_categories[i];
693 if( !strcmp( p_cat->psz_name, psz_cat ) )
695 if( pi_index )
696 *pi_index = i;
697 return p_cat;
700 return NULL;
704 * Get a info item from a given category in a given input item.
706 * \param p_i The input item to get info from
707 * \param psz_cat String representing the category for the info
708 * \param psz_name String representing the name of the desired info
709 * \return A pointer to the string with the given info if found, or an
710 * empty string otherwise. The caller should free the returned
711 * pointer.
713 char *input_item_GetInfo( input_item_t *p_i,
714 const char *psz_cat,
715 const char *psz_name )
717 vlc_mutex_lock( &p_i->lock );
719 const info_category_t *p_cat = InputItemFindCat( p_i, NULL, psz_cat );
720 if( p_cat )
722 info_t *p_info = info_category_FindInfo( p_cat, NULL, psz_name );
723 if( p_info && p_info->psz_value )
725 char *psz_ret = strdup( p_info->psz_value );
726 vlc_mutex_unlock( &p_i->lock );
727 return psz_ret;
730 vlc_mutex_unlock( &p_i->lock );
731 return strdup( "" );
734 static int InputItemVaAddInfo( input_item_t *p_i,
735 const char *psz_cat,
736 const char *psz_name,
737 const char *psz_format, va_list args )
739 vlc_assert_locked( &p_i->lock );
741 info_category_t *p_cat = InputItemFindCat( p_i, NULL, psz_cat );
742 if( !p_cat )
744 p_cat = info_category_New( psz_cat );
745 if( !p_cat )
746 return VLC_ENOMEM;
747 TAB_APPEND(p_i->i_categories, p_i->pp_categories, p_cat);
749 info_t *p_info = info_category_VaAddInfo( p_cat, psz_name, psz_format, args );
750 if( !p_info || !p_info->psz_value )
751 return VLC_EGENERIC;
752 return VLC_SUCCESS;
755 int input_item_AddInfo( input_item_t *p_i,
756 const char *psz_cat,
757 const char *psz_name,
758 const char *psz_format, ... )
760 va_list args;
762 vlc_mutex_lock( &p_i->lock );
764 va_start( args, psz_format );
765 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
766 va_end( args );
768 vlc_mutex_unlock( &p_i->lock );
771 if( !i_ret )
772 vlc_event_send( &p_i->event_manager, &(vlc_event_t) {
773 .type = vlc_InputItemInfoChanged } );
775 return i_ret;
778 int input_item_DelInfo( input_item_t *p_i,
779 const char *psz_cat,
780 const char *psz_name )
782 vlc_mutex_lock( &p_i->lock );
783 int i_cat;
784 info_category_t *p_cat = InputItemFindCat( p_i, &i_cat, psz_cat );
785 if( !p_cat )
787 vlc_mutex_unlock( &p_i->lock );
788 return VLC_EGENERIC;
791 if( psz_name )
793 /* Remove a specific info */
794 int i_ret = info_category_DeleteInfo( p_cat, psz_name );
795 if( i_ret )
797 vlc_mutex_unlock( &p_i->lock );
798 return VLC_EGENERIC;
801 else
803 /* Remove the complete categorie */
804 info_category_Delete( p_cat );
805 TAB_ERASE(p_i->i_categories, p_i->pp_categories, i_cat);
807 vlc_mutex_unlock( &p_i->lock );
809 vlc_event_send( &p_i->event_manager,
810 &(vlc_event_t) { .type = vlc_InputItemInfoChanged } );
812 return VLC_SUCCESS;
814 void input_item_ReplaceInfos( input_item_t *p_item, info_category_t *p_cat )
816 vlc_mutex_lock( &p_item->lock );
817 int i_cat;
818 info_category_t *p_old = InputItemFindCat( p_item, &i_cat, p_cat->psz_name );
819 if( p_old )
821 info_category_Delete( p_old );
822 p_item->pp_categories[i_cat] = p_cat;
824 else
825 TAB_APPEND(p_item->i_categories, p_item->pp_categories, p_cat);
826 vlc_mutex_unlock( &p_item->lock );
828 vlc_event_send( &p_item->event_manager,
829 &(vlc_event_t) { .type = vlc_InputItemInfoChanged } );
832 void input_item_MergeInfos( input_item_t *p_item, info_category_t *p_cat )
834 vlc_mutex_lock( &p_item->lock );
835 info_category_t *p_old = InputItemFindCat( p_item, NULL, p_cat->psz_name );
836 if( p_old )
838 for( int i = 0; i < p_cat->i_infos; i++ )
839 info_category_ReplaceInfo( p_old, p_cat->pp_infos[i] );
840 TAB_CLEAN( p_cat->i_infos, p_cat->pp_infos );
841 info_category_Delete( p_cat );
843 else
844 TAB_APPEND(p_item->i_categories, p_item->pp_categories, p_cat);
845 vlc_mutex_unlock( &p_item->lock );
847 vlc_event_send( &p_item->event_manager,
848 &(vlc_event_t) { .type = vlc_InputItemInfoChanged } );
851 void input_item_SetEpgEvent( input_item_t *p_item, const vlc_epg_event_t *p_epg_evt )
853 bool b_changed = false;
854 vlc_mutex_lock( &p_item->lock );
856 for( int i = 0; i < p_item->i_epg; i++ )
858 vlc_epg_t *p_epg = p_item->pp_epg[i];
859 for( size_t j = 0; j < p_epg->i_event; j++ )
861 /* Same event can exist in more than one table */
862 if( p_epg->pp_event[j]->i_id == p_epg_evt->i_id )
864 vlc_epg_event_t *p_dup = vlc_epg_event_Duplicate( p_epg_evt );
865 if( p_dup )
867 if( p_epg->p_current == p_epg->pp_event[j] )
868 p_epg->p_current = p_dup;
869 vlc_epg_event_Delete( p_epg->pp_event[j] );
870 p_epg->pp_event[j] = p_dup;
871 b_changed = true;
873 break;
877 vlc_mutex_unlock( &p_item->lock );
879 if ( b_changed )
881 vlc_event_send( &p_item->event_manager,
882 &(vlc_event_t) { .type = vlc_InputItemInfoChanged } );
886 //#define EPG_DEBUG
887 #ifdef EPG_DEBUG
888 static int InputItemAddInfo( input_item_t *p_i,
889 const char *psz_cat,
890 const char *psz_name,
891 const char *psz_format, ... )
893 va_list args;
895 va_start( args, psz_format );
896 const int i_ret = InputItemVaAddInfo( p_i, psz_cat, psz_name, psz_format, args );
897 va_end( args );
899 return i_ret;
901 #endif
903 void input_item_SetEpg( input_item_t *p_item, const vlc_epg_t *p_update, bool b_current_source )
905 vlc_epg_t *p_epg = vlc_epg_Duplicate( p_update );
906 if( !p_epg )
907 return;
909 vlc_mutex_lock( &p_item->lock );
911 /* */
912 vlc_epg_t **pp_epg = NULL;
913 for( int i = 0; i < p_item->i_epg; i++ )
915 if( p_item->pp_epg[i]->i_source_id == p_update->i_source_id &&
916 p_item->pp_epg[i]->i_id == p_update->i_id )
918 pp_epg = &p_item->pp_epg[i];
919 break;
923 /* replace with new version */
924 if( pp_epg )
926 vlc_epg_Delete( *pp_epg );
927 if( *pp_epg == p_item->p_epg_table ) /* current table can have changed */
928 p_item->p_epg_table = NULL;
929 *pp_epg = p_epg;
931 else
933 TAB_APPEND( p_item->i_epg, p_item->pp_epg, p_epg );
936 if( b_current_source && p_epg->b_present )
937 p_item->p_epg_table = p_epg;
939 vlc_mutex_unlock( &p_item->lock );
941 #ifdef EPG_DEBUG
942 char *psz_epg;
943 if( asprintf( &psz_epg, "EPG %s", p_epg->psz_name ? p_epg->psz_name : "unknown" ) < 0 )
944 goto signal;
946 input_item_DelInfo( p_item, psz_epg, NULL );
948 vlc_mutex_lock( &p_item->lock );
949 for( size_t i = 0; i < p_epg->i_event; i++ )
951 const vlc_epg_event_t *p_evt = p_epg->pp_event[i];
952 time_t t_start = (time_t)p_evt->i_start;
953 struct tm tm_start;
954 char psz_start[128];
956 localtime_r( &t_start, &tm_start );
958 snprintf( psz_start, sizeof(psz_start), "%4.4d-%2.2d-%2.2d %2.2d:%2.2d:%2.2d",
959 1900 + tm_start.tm_year, 1 + tm_start.tm_mon, tm_start.tm_mday,
960 tm_start.tm_hour, tm_start.tm_min, tm_start.tm_sec );
961 if( p_evt->psz_short_description || p_evt->psz_description )
962 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d) - %s %s",
963 p_evt->psz_name,
964 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60,
965 p_evt->psz_short_description ? p_evt->psz_short_description : "" ,
966 p_evt->psz_description ? p_evt->psz_description : "" );
967 else
968 InputItemAddInfo( p_item, psz_epg, psz_start, "%s (%2.2d:%2.2d)",
969 p_evt->psz_name,
970 p_evt->i_duration/60/60, (p_evt->i_duration/60)%60 );
972 vlc_mutex_unlock( &p_item->lock );
973 free( psz_epg );
974 signal:
975 #endif
976 vlc_event_send( &p_item->event_manager,
977 &(vlc_event_t){ .type = vlc_InputItemInfoChanged, } );
980 void input_item_ChangeEPGSource( input_item_t *p_item, int i_source_id )
982 vlc_mutex_lock( &p_item->lock );
983 p_item->p_epg_table = NULL;
984 if( i_source_id > 0 )
986 /* Update pointer to current/next table in the full schedule */
987 for( int i = 0; i < p_item->i_epg; i++ )
989 if( p_item->pp_epg[i]->i_source_id == i_source_id &&
990 p_item->pp_epg[i]->b_present )
992 p_item->p_epg_table = p_item->pp_epg[i];
993 break;
997 vlc_mutex_unlock( &p_item->lock );
1000 void input_item_SetEpgTime( input_item_t *p_item, int64_t i_time )
1002 vlc_mutex_lock( &p_item->lock );
1003 p_item->i_epg_time = i_time;
1004 vlc_mutex_unlock( &p_item->lock );
1007 void input_item_SetEpgOffline( input_item_t *p_item )
1009 input_item_ChangeEPGSource( p_item, -1 );
1011 #ifdef EPG_DEBUG
1012 vlc_mutex_lock( &p_item->lock );
1013 const int i_epg_info = p_item->i_epg;
1014 if( i_epg_info > 0 )
1016 char *ppsz_epg_info[i_epg_info];
1017 for( int i = 0; i < p_item->i_epg; i++ )
1019 const vlc_epg_t *p_epg = p_item->pp_epg[i];
1020 if( asprintf( &ppsz_epg_info[i], "EPG %s", p_epg->psz_name ? p_epg->psz_name : "unknown" ) < 0 )
1021 ppsz_epg_info[i] = NULL;
1023 vlc_mutex_unlock( &p_item->lock );
1025 for( int i = 0; i < i_epg_info; i++ )
1027 if( !ppsz_epg_info[i] )
1028 continue;
1029 input_item_DelInfo( p_item, ppsz_epg_info[i], NULL );
1030 free( ppsz_epg_info[i] );
1033 else
1034 vlc_mutex_unlock( &p_item->lock );
1035 #endif
1037 vlc_event_send( &p_item->event_manager,
1038 &(vlc_event_t) { .type = vlc_InputItemInfoChanged } );
1041 input_item_t *
1042 input_item_NewExt( const char *psz_uri, const char *psz_name,
1043 mtime_t duration, int type, enum input_item_net_type i_net )
1045 input_item_owner_t *owner = calloc( 1, sizeof( *owner ) );
1046 if( unlikely(owner == NULL) )
1047 return NULL;
1049 atomic_init( &owner->refs, 1 );
1051 input_item_t *p_input = &owner->item;
1052 vlc_event_manager_t * p_em = &p_input->event_manager;
1054 vlc_mutex_init( &p_input->lock );
1056 p_input->psz_name = NULL;
1057 if( psz_name )
1058 input_item_SetName( p_input, psz_name );
1060 p_input->psz_uri = NULL;
1061 if( psz_uri )
1062 input_item_SetURI( p_input, psz_uri );
1063 else
1065 p_input->i_type = ITEM_TYPE_UNKNOWN;
1066 p_input->b_net = false;
1069 TAB_INIT( p_input->i_options, p_input->ppsz_options );
1070 p_input->optflagc = 0;
1071 p_input->optflagv = NULL;
1072 p_input->opaques = NULL;
1074 p_input->i_duration = duration;
1075 TAB_INIT( p_input->i_categories, p_input->pp_categories );
1076 TAB_INIT( p_input->i_es, p_input->es );
1077 p_input->p_stats = NULL;
1078 p_input->p_meta = NULL;
1079 TAB_INIT( p_input->i_epg, p_input->pp_epg );
1080 TAB_INIT( p_input->i_slaves, p_input->pp_slaves );
1082 vlc_event_manager_init( p_em, p_input );
1084 if( type != ITEM_TYPE_UNKNOWN )
1085 p_input->i_type = type;
1086 p_input->b_error_when_reading = false;
1088 if( i_net != ITEM_NET_UNKNOWN )
1089 p_input->b_net = i_net == ITEM_NET;
1090 return p_input;
1093 input_item_t *input_item_Copy( input_item_t *p_input )
1095 vlc_meta_t *meta = NULL;
1096 input_item_t *item;
1097 bool b_net;
1099 vlc_mutex_lock( &p_input->lock );
1101 item = input_item_NewExt( p_input->psz_uri, p_input->psz_name,
1102 p_input->i_duration, p_input->i_type,
1103 ITEM_NET_UNKNOWN );
1104 if( likely(item != NULL) && p_input->p_meta != NULL )
1106 meta = vlc_meta_New();
1107 vlc_meta_Merge( meta, p_input->p_meta );
1109 b_net = p_input->b_net;
1110 vlc_mutex_unlock( &p_input->lock );
1112 if( likely(item != NULL) )
1113 { /* No need to lock; no other thread has seen this new item yet. */
1114 input_item_CopyOptions( item, p_input );
1115 item->p_meta = meta;
1116 item->b_net = b_net;
1119 return item;
1122 struct item_type_entry
1124 const char *psz_scheme;
1125 uint8_t i_type;
1126 bool b_net;
1129 static int typecmp( const void *key, const void *entry )
1131 const struct item_type_entry *type = entry;
1132 const char *uri = key, *scheme = type->psz_scheme;
1134 return strncmp( uri, scheme, strlen( scheme ) );
1137 /* Guess the type of the item using the beginning of the mrl */
1138 static int GuessType( const input_item_t *p_item, bool *p_net )
1140 static const struct item_type_entry tab[] =
1141 { /* /!\ Alphabetical order /!\ */
1142 /* Short match work, not just exact match */
1143 { "alsa", ITEM_TYPE_CARD, false },
1144 { "atsc", ITEM_TYPE_CARD, false },
1145 { "bd", ITEM_TYPE_DISC, false },
1146 { "bluray", ITEM_TYPE_DISC, false },
1147 { "cable", ITEM_TYPE_CARD, false },
1148 { "cdda", ITEM_TYPE_DISC, false },
1149 { "cqam", ITEM_TYPE_CARD, false },
1150 { "dc1394", ITEM_TYPE_CARD, false },
1151 { "dccp", ITEM_TYPE_STREAM, true },
1152 { "deckli", ITEM_TYPE_CARD, false }, /* decklink */
1153 { "dir", ITEM_TYPE_DIRECTORY, false },
1154 { "dshow", ITEM_TYPE_CARD, false },
1155 { "dtv", ITEM_TYPE_CARD, false },
1156 { "dvb", ITEM_TYPE_CARD, false },
1157 { "dvd", ITEM_TYPE_DISC, false },
1158 { "eyetv", ITEM_TYPE_CARD, false },
1159 { "fd", ITEM_TYPE_UNKNOWN, false },
1160 { "file", ITEM_TYPE_FILE, false },
1161 { "ftp", ITEM_TYPE_FILE, true },
1162 { "http", ITEM_TYPE_FILE, true },
1163 { "icyx", ITEM_TYPE_STREAM, true },
1164 { "imem", ITEM_TYPE_UNKNOWN, false },
1165 { "isdb-", ITEM_TYPE_CARD, false },
1166 { "itpc", ITEM_TYPE_PLAYLIST, true },
1167 { "jack", ITEM_TYPE_CARD, false },
1168 { "linsys", ITEM_TYPE_CARD, false },
1169 { "live", ITEM_TYPE_STREAM, true }, /* livedotcom */
1170 { "mms", ITEM_TYPE_STREAM, true },
1171 { "mtp", ITEM_TYPE_DISC, false },
1172 { "nfs", ITEM_TYPE_FILE, true },
1173 { "ofdm", ITEM_TYPE_CARD, false },
1174 { "oss", ITEM_TYPE_CARD, false },
1175 { "pnm", ITEM_TYPE_STREAM, true },
1176 { "pulse", ITEM_TYPE_CARD, false },
1177 { "qam", ITEM_TYPE_CARD, false },
1178 { "qpsk", ITEM_TYPE_CARD, false },
1179 { "qtcapt", ITEM_TYPE_CARD, false }, /* qtcapture */
1180 { "qtsound",ITEM_TYPE_CARD, false },
1181 { "raw139", ITEM_TYPE_CARD, false }, /* raw1394 */
1182 { "rt", ITEM_TYPE_STREAM, true }, /* rtp, rtsp, rtmp */
1183 { "satell", ITEM_TYPE_CARD, false }, /* satellite */
1184 { "satip", ITEM_TYPE_STREAM, true }, /* satellite over ip */
1185 { "screen", ITEM_TYPE_CARD, false },
1186 { "sdp", ITEM_TYPE_STREAM, true },
1187 { "sftp", ITEM_TYPE_FILE, true },
1188 { "shm", ITEM_TYPE_CARD, false },
1189 { "smb", ITEM_TYPE_FILE, true },
1190 { "stream", ITEM_TYPE_STREAM, false },
1191 { "svcd", ITEM_TYPE_DISC, false },
1192 { "tcp", ITEM_TYPE_STREAM, true },
1193 { "terres", ITEM_TYPE_CARD, false }, /* terrestrial */
1194 { "udp", ITEM_TYPE_STREAM, true }, /* udplite too */
1195 { "unsv", ITEM_TYPE_STREAM, true },
1196 { "upnp", ITEM_TYPE_FILE, true },
1197 { "usdigi", ITEM_TYPE_CARD, false }, /* usdigital */
1198 { "v4l", ITEM_TYPE_CARD, false },
1199 { "vcd", ITEM_TYPE_DISC, false },
1200 { "vdr", ITEM_TYPE_STREAM, true },
1201 { "wasapi", ITEM_TYPE_CARD, false },
1202 { "window", ITEM_TYPE_CARD, false },
1205 #ifndef NDEBUG
1206 for( size_t i = 1; i < ARRAY_SIZE( tab ); i++ )
1207 assert( typecmp( (tab + i)->psz_scheme, tab + i - 1 ) > 0 );
1208 #endif
1210 *p_net = false;
1212 if( strstr( p_item->psz_uri, "://" ) == NULL )
1213 return ITEM_TYPE_UNKNOWN; /* invalid URI */
1215 const struct item_type_entry *e =
1216 bsearch( p_item->psz_uri, tab, ARRAY_SIZE( tab ),
1217 sizeof( tab[0] ), typecmp );
1218 if( e == NULL )
1219 return ITEM_TYPE_UNKNOWN;
1221 *p_net = e->b_net;
1222 return e->i_type;
1225 input_item_node_t *input_item_node_Create( input_item_t *p_input )
1227 input_item_node_t* p_node = malloc( sizeof( input_item_node_t ) );
1228 if( !p_node )
1229 return NULL;
1231 assert( p_input );
1233 p_node->p_item = p_input;
1234 input_item_Hold( p_input );
1236 p_node->i_children = 0;
1237 p_node->pp_children = NULL;
1239 return p_node;
1242 void input_item_node_Delete( input_item_node_t *p_node )
1244 for( int i = 0; i < p_node->i_children; i++ )
1245 input_item_node_Delete( p_node->pp_children[i] );
1247 input_item_Release( p_node->p_item );
1248 free( p_node->pp_children );
1249 free( p_node );
1252 input_item_node_t *input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item )
1254 int i_preparse_depth;
1255 input_item_node_t *p_new_child = input_item_node_Create( p_item );
1256 if( !p_new_child ) return NULL;
1258 vlc_mutex_lock( &p_node->p_item->lock );
1259 i_preparse_depth = p_node->p_item->i_preparse_depth;
1260 vlc_mutex_unlock( &p_node->p_item->lock );
1262 vlc_mutex_lock( &p_item->lock );
1263 p_item->i_preparse_depth = i_preparse_depth > 0 ?
1264 i_preparse_depth -1 :
1265 i_preparse_depth;
1266 vlc_mutex_unlock( &p_item->lock );
1268 input_item_node_AppendNode( p_node, p_new_child );
1269 return p_new_child;
1272 void input_item_node_AppendNode( input_item_node_t *p_parent,
1273 input_item_node_t *p_child )
1275 assert(p_parent != NULL);
1276 assert(p_child != NULL);
1277 TAB_APPEND(p_parent->i_children, p_parent->pp_children, p_child);
1280 void input_item_node_RemoveNode( input_item_node_t *parent,
1281 input_item_node_t *child )
1283 TAB_REMOVE(parent->i_children, parent->pp_children, child);
1286 void input_item_node_PostAndDelete( input_item_node_t *p_root )
1288 vlc_event_send( &p_root->p_item->event_manager, &(vlc_event_t) {
1289 .type = vlc_InputItemSubItemTreeAdded,
1290 .u.input_item_subitem_tree_added.p_root = p_root } );
1292 input_item_node_Delete( p_root );
1295 /* Called by es_out when a new Elementary Stream is added or updated. */
1296 void input_item_UpdateTracksInfo(input_item_t *item, const es_format_t *fmt)
1298 int i;
1299 es_format_t *fmt_copy = malloc(sizeof *fmt_copy);
1300 if (!fmt_copy)
1301 return;
1303 es_format_Copy(fmt_copy, fmt);
1305 vlc_mutex_lock( &item->lock );
1307 for( i = 0; i < item->i_es; i++ )
1309 if (item->es[i]->i_id != fmt->i_id)
1310 continue;
1312 /* We've found the right ES, replace it */
1313 es_format_Clean(item->es[i]);
1314 free(item->es[i]);
1315 item->es[i] = fmt_copy;
1316 vlc_mutex_unlock( &item->lock );
1317 return;
1320 /* ES not found, insert it */
1321 TAB_APPEND(item->i_es, item->es, fmt_copy);
1322 vlc_mutex_unlock( &item->lock );
1325 static int rdh_compar_type(input_item_t *p1, input_item_t *p2)
1327 if (p1->i_type != p2->i_type)
1329 if (p1->i_type == ITEM_TYPE_DIRECTORY)
1330 return -1;
1331 if (p2->i_type == ITEM_TYPE_DIRECTORY)
1332 return 1;
1334 return 0;
1337 static int rdh_compar_filename(const void *a, const void *b)
1339 input_item_node_t *const *na = a, *const *nb = b;
1340 input_item_t *ia = (*na)->p_item, *ib = (*nb)->p_item;
1342 int i_ret = rdh_compar_type(ia, ib);
1343 if (i_ret != 0)
1344 return i_ret;
1346 return vlc_filenamecmp(ia->psz_name, ib->psz_name);
1349 static void rdh_sort(input_item_node_t *p_node)
1351 if (p_node->i_children <= 0)
1352 return;
1354 /* Sort current node */
1355 qsort(p_node->pp_children, p_node->i_children,
1356 sizeof(input_item_node_t *), rdh_compar_filename);
1358 /* Sort all children */
1359 for (int i = 0; i < p_node->i_children; i++)
1360 rdh_sort(p_node->pp_children[i]);
1364 * Does the provided file name has one of the extension provided ?
1366 static bool rdh_file_has_ext(const char *psz_filename,
1367 const char *psz_ignored_exts)
1369 if (psz_ignored_exts == NULL)
1370 return false;
1372 const char *ext = strrchr(psz_filename, '.');
1373 if (ext == NULL)
1374 return false;
1376 size_t extlen = strlen(++ext);
1378 for (const char *type = psz_ignored_exts, *end; type[0]; type = end + 1)
1380 end = strchr(type, ',');
1381 if (end == NULL)
1382 end = type + strlen(type);
1384 if (type + extlen == end && !strncasecmp(ext, type, extlen))
1385 return true;
1387 if (*end == '\0')
1388 break;
1391 return false;
1394 static bool rdh_file_is_ignored(struct vlc_readdir_helper *p_rdh,
1395 const char *psz_filename)
1397 return (psz_filename[0] == '\0'
1398 || strcmp(psz_filename, ".") == 0
1399 || strcmp(psz_filename, "..") == 0
1400 || (!p_rdh->b_show_hiddenfiles && psz_filename[0] == '.')
1401 || rdh_file_has_ext(psz_filename, p_rdh->psz_ignored_exts));
1404 struct rdh_slave
1406 input_item_slave_t *p_slave;
1407 char *psz_filename;
1408 input_item_node_t *p_node;
1411 struct rdh_dir
1413 input_item_node_t *p_node;
1414 char psz_path[];
1417 static char *rdh_name_from_filename(const char *psz_filename)
1419 /* remove leading white spaces */
1420 while (*psz_filename != '\0' && *psz_filename == ' ')
1421 psz_filename++;
1423 char *psz_name = strdup(psz_filename);
1424 if (!psz_name)
1425 return NULL;
1427 /* remove extension */
1428 char *psz_ptr = strrchr(psz_name, '.');
1429 if (psz_ptr && psz_ptr != psz_name)
1430 *psz_ptr = '\0';
1432 /* remove trailing white spaces */
1433 int i = strlen(psz_name) - 1;
1434 while (psz_name[i] == ' ' && i >= 0)
1435 psz_name[i--] = '\0';
1437 /* convert to lower case */
1438 psz_ptr = psz_name;
1439 while (*psz_ptr != '\0')
1441 *psz_ptr = tolower(*psz_ptr);
1442 psz_ptr++;
1445 return psz_name;
1448 static uint8_t rdh_get_slave_priority(input_item_t *p_item,
1449 input_item_slave_t *p_slave,
1450 const char *psz_slave_filename)
1452 uint8_t i_priority = SLAVE_PRIORITY_MATCH_NONE;
1453 char *psz_item_name = rdh_name_from_filename(p_item->psz_name);
1454 char *psz_slave_name = rdh_name_from_filename(psz_slave_filename);
1456 if (!psz_item_name || !psz_slave_name)
1457 goto done;
1459 /* check if the names match exactly */
1460 if (!strcmp(psz_item_name, psz_slave_name))
1462 i_priority = SLAVE_PRIORITY_MATCH_ALL;
1463 goto done;
1466 /* "cdg" slaves have to be a full match */
1467 if (p_slave->i_type == SLAVE_TYPE_SPU)
1469 char *psz_ext = strrchr(psz_slave_name, '.');
1470 if (psz_ext != NULL && strcasecmp(++psz_ext, "cdg") == 0)
1471 goto done;
1474 /* check if the item name is a substring of the slave name */
1475 const char *psz_sub = strstr(psz_slave_name, psz_item_name);
1477 if (psz_sub)
1479 /* check if the item name was found at the end of the slave name */
1480 if (strlen(psz_sub + strlen(psz_item_name)) == 0)
1482 i_priority = SLAVE_PRIORITY_MATCH_RIGHT;
1483 goto done;
1485 else
1487 i_priority = SLAVE_PRIORITY_MATCH_LEFT;
1488 goto done;
1492 done:
1493 free(psz_item_name);
1494 free(psz_slave_name);
1495 return i_priority;
1498 static int rdh_should_match_idx(struct vlc_readdir_helper *p_rdh,
1499 struct rdh_slave *p_rdh_sub)
1501 char *psz_ext = strrchr(p_rdh_sub->psz_filename, '.');
1502 if (!psz_ext)
1503 return false;
1504 psz_ext++;
1506 if (strcasecmp(psz_ext, "sub") != 0)
1507 return false;
1509 for (size_t i = 0; i < p_rdh->i_slaves; i++)
1511 struct rdh_slave *p_rdh_slave = p_rdh->pp_slaves[i];
1513 if (p_rdh_slave == NULL || p_rdh_slave == p_rdh_sub)
1514 continue;
1516 /* check that priorities match */
1517 if (p_rdh_slave->p_slave->i_priority !=
1518 p_rdh_sub->p_slave->i_priority)
1519 continue;
1521 /* check that the filenames without extension match */
1522 if (strncasecmp(p_rdh_sub->psz_filename, p_rdh_slave->psz_filename,
1523 strlen(p_rdh_sub->psz_filename) - 3 ) != 0)
1524 continue;
1526 /* check that we have an idx file */
1527 char *psz_ext_idx = strrchr(p_rdh_slave->psz_filename, '.');
1528 if (psz_ext_idx == NULL)
1529 continue;
1530 psz_ext_idx++;
1531 if (strcasecmp(psz_ext_idx, "idx" ) == 0)
1532 return true;
1534 return false;
1537 static void rdh_attach_slaves(struct vlc_readdir_helper *p_rdh,
1538 input_item_node_t *p_parent_node)
1540 if (p_rdh->i_sub_autodetect_fuzzy == 0)
1541 return;
1543 /* Try to match slaves for each items of the node */
1544 for (int i = 0; i < p_parent_node->i_children; i++)
1546 input_item_node_t *p_node = p_parent_node->pp_children[i];
1547 input_item_t *p_item = p_node->p_item;
1549 for (size_t j = 0; j < p_rdh->i_slaves; j++)
1551 struct rdh_slave *p_rdh_slave = p_rdh->pp_slaves[j];
1553 /* Don't try to match slaves with themselves or slaves already
1554 * attached with the higher priority */
1555 if (p_rdh_slave->p_node == p_node
1556 || p_rdh_slave->p_slave->i_priority == SLAVE_PRIORITY_MATCH_ALL)
1557 continue;
1559 uint8_t i_priority =
1560 rdh_get_slave_priority(p_item, p_rdh_slave->p_slave,
1561 p_rdh_slave->psz_filename);
1563 if (i_priority < p_rdh->i_sub_autodetect_fuzzy)
1564 continue;
1566 /* Drop the ".sub" slave if a ".idx" slave matches */
1567 if (p_rdh_slave->p_slave->i_type == SLAVE_TYPE_SPU
1568 && rdh_should_match_idx(p_rdh, p_rdh_slave))
1569 continue;
1571 input_item_slave_t *p_slave =
1572 input_item_slave_New(p_rdh_slave->p_slave->psz_uri,
1573 p_rdh_slave->p_slave->i_type,
1574 i_priority);
1575 if (p_slave == NULL)
1576 break;
1578 if (input_item_AddSlave(p_item, p_slave) != VLC_SUCCESS)
1580 input_item_slave_Delete(p_slave);
1581 break;
1584 /* Remove the corresponding node if any: This slave won't be
1585 * added in the parent node */
1586 if (p_rdh_slave->p_node != NULL)
1588 input_item_node_RemoveNode(p_parent_node, p_rdh_slave->p_node);
1589 input_item_node_Delete(p_rdh_slave->p_node);
1590 p_rdh_slave->p_node = NULL;
1593 p_rdh_slave->p_slave->i_priority = i_priority;
1597 /* Attach all children */
1598 for (int i = 0; i < p_parent_node->i_children; i++)
1599 rdh_attach_slaves(p_rdh, p_parent_node->pp_children[i]);
1602 static int rdh_unflatten(struct vlc_readdir_helper *p_rdh,
1603 input_item_node_t **pp_node, const char *psz_path,
1604 int i_net)
1606 /* Create an input input for each sub folders that is contained in the full
1607 * path. Update pp_node to point to the direct parent of the future item to
1608 * add. */
1610 assert(psz_path != NULL);
1611 const char *psz_subpaths = psz_path;
1613 while ((psz_subpaths = strchr(psz_subpaths, '/')))
1615 input_item_node_t *p_subnode = NULL;
1617 /* Check if this sub folder item was already added */
1618 for (size_t i = 0; i < p_rdh->i_dirs && p_subnode == NULL; i++)
1620 struct rdh_dir *rdh_dir = p_rdh->pp_dirs[i];
1621 if (!strncmp(rdh_dir->psz_path, psz_path, psz_subpaths - psz_path))
1622 p_subnode = rdh_dir->p_node;
1625 /* The sub folder item doesn't exist, so create it */
1626 if (p_subnode == NULL)
1628 size_t i_sub_path_len = psz_subpaths - psz_path;
1629 struct rdh_dir *p_rdh_dir =
1630 malloc(sizeof(struct rdh_dir) + 1 + i_sub_path_len);
1631 if (p_rdh_dir == NULL)
1632 return VLC_ENOMEM;
1633 strncpy(p_rdh_dir->psz_path, psz_path, i_sub_path_len);
1634 p_rdh_dir->psz_path[i_sub_path_len] = 0;
1636 const char *psz_subpathname = strrchr(p_rdh_dir->psz_path, '/');
1637 if (psz_subpathname != NULL)
1638 ++psz_subpathname;
1639 else
1640 psz_subpathname = p_rdh_dir->psz_path;
1642 input_item_t *p_item =
1643 input_item_NewExt("vlc://nop", psz_subpathname, -1,
1644 ITEM_TYPE_DIRECTORY, i_net);
1645 if (p_item == NULL)
1647 free(p_rdh_dir);
1648 return VLC_ENOMEM;
1650 input_item_CopyOptions(p_item, (*pp_node)->p_item);
1651 *pp_node = input_item_node_AppendItem(*pp_node, p_item);
1652 input_item_Release(p_item);
1653 if (*pp_node == NULL)
1655 free(p_rdh_dir);
1656 return VLC_ENOMEM;
1658 p_rdh_dir->p_node = *pp_node;
1659 TAB_APPEND(p_rdh->i_dirs, p_rdh->pp_dirs, p_rdh_dir);
1661 else
1662 *pp_node = p_subnode;
1663 psz_subpaths++;
1665 return VLC_SUCCESS;
1668 #undef vlc_readdir_helper_init
1669 void vlc_readdir_helper_init(struct vlc_readdir_helper *p_rdh,
1670 vlc_object_t *p_obj, input_item_node_t *p_node)
1672 /* Read options from the parent item. This allows vlc_stream_ReadDir()
1673 * users to specify options whitout touhing any vlc_object_t. Apply options
1674 * on a temporary object in order to not apply options (that can be
1675 * insecure) to the current object. */
1676 vlc_object_t *p_var_obj = vlc_object_create(p_obj, sizeof(vlc_object_t));
1677 if (p_var_obj != NULL)
1679 input_item_ApplyOptions(p_var_obj, p_node->p_item);
1680 p_obj = p_var_obj;
1683 p_rdh->p_node = p_node;
1684 p_rdh->b_show_hiddenfiles = var_InheritBool(p_obj, "show-hiddenfiles");
1685 p_rdh->psz_ignored_exts = var_InheritString(p_obj, "ignore-filetypes");
1686 bool b_autodetect = var_InheritBool(p_obj, "sub-autodetect-file");
1687 p_rdh->i_sub_autodetect_fuzzy = !b_autodetect ? 0 :
1688 var_InheritInteger(p_obj, "sub-autodetect-fuzzy");
1689 p_rdh->b_flatten = var_InheritBool(p_obj, "extractor-flatten");
1690 TAB_INIT(p_rdh->i_slaves, p_rdh->pp_slaves);
1691 TAB_INIT(p_rdh->i_dirs, p_rdh->pp_dirs);
1693 if (p_var_obj != NULL)
1694 vlc_object_release(p_var_obj);
1697 void vlc_readdir_helper_finish(struct vlc_readdir_helper *p_rdh, bool b_success)
1699 if (b_success)
1701 rdh_attach_slaves(p_rdh, p_rdh->p_node);
1702 rdh_sort(p_rdh->p_node);
1704 free(p_rdh->psz_ignored_exts);
1706 /* Remove unmatched slaves */
1707 for (size_t i = 0; i < p_rdh->i_slaves; i++)
1709 struct rdh_slave *p_rdh_slave = p_rdh->pp_slaves[i];
1710 if (p_rdh_slave != NULL)
1712 input_item_slave_Delete(p_rdh_slave->p_slave);
1713 free(p_rdh_slave->psz_filename);
1714 free(p_rdh_slave);
1717 TAB_CLEAN(p_rdh->i_slaves, p_rdh->pp_slaves);
1719 for (size_t i = 0; i < p_rdh->i_dirs; i++)
1720 free(p_rdh->pp_dirs[i]);
1721 TAB_CLEAN(p_rdh->i_dirs, p_rdh->pp_dirs);
1724 int vlc_readdir_helper_additem(struct vlc_readdir_helper *p_rdh,
1725 const char *psz_uri, const char *psz_flatpath,
1726 const char *psz_filename, int i_type, int i_net)
1728 enum slave_type i_slave_type;
1729 struct rdh_slave *p_rdh_slave = NULL;
1730 assert(psz_flatpath || psz_filename);
1732 if (!p_rdh->b_flatten)
1734 if (psz_filename == NULL)
1736 psz_filename = strrchr(psz_flatpath, '/');
1737 if (psz_filename != NULL)
1738 ++psz_filename;
1739 else
1740 psz_filename = psz_flatpath;
1743 else
1745 if (psz_filename == NULL)
1746 psz_filename = psz_flatpath;
1747 psz_flatpath = NULL;
1750 if (p_rdh->i_sub_autodetect_fuzzy != 0
1751 && input_item_slave_GetType(psz_filename, &i_slave_type))
1753 p_rdh_slave = malloc(sizeof(*p_rdh_slave));
1754 if (!p_rdh_slave)
1755 return VLC_ENOMEM;
1757 p_rdh_slave->p_node = NULL;
1758 p_rdh_slave->psz_filename = strdup(psz_filename);
1759 p_rdh_slave->p_slave = input_item_slave_New(psz_uri, i_slave_type,
1760 SLAVE_PRIORITY_MATCH_NONE);
1761 if (!p_rdh_slave->p_slave || !p_rdh_slave->psz_filename)
1763 free(p_rdh_slave->psz_filename);
1764 free(p_rdh_slave);
1765 return VLC_ENOMEM;
1768 TAB_APPEND(p_rdh->i_slaves, p_rdh->pp_slaves, p_rdh_slave);
1771 if (rdh_file_is_ignored(p_rdh, psz_filename))
1772 return VLC_SUCCESS;
1774 input_item_node_t *p_node = p_rdh->p_node;
1776 if (psz_flatpath != NULL)
1778 int i_ret = rdh_unflatten(p_rdh, &p_node, psz_flatpath, i_net);
1779 if (i_ret != VLC_SUCCESS)
1780 return i_ret;
1783 input_item_t *p_item = input_item_NewExt(psz_uri, psz_filename, -1, i_type,
1784 i_net);
1785 if (p_item == NULL)
1786 return VLC_ENOMEM;
1788 input_item_CopyOptions(p_item, p_node->p_item);
1789 p_node = input_item_node_AppendItem(p_node, p_item);
1790 input_item_Release(p_item);
1791 if (p_node == NULL)
1792 return VLC_ENOMEM;
1794 /* A slave can also be an item. If there is a match, this item will be
1795 * removed from the parent node. This is not a common case, since most
1796 * slaves will be ignored by rdh_file_is_ignored() */
1797 if (p_rdh_slave != NULL)
1798 p_rdh_slave->p_node = p_node;
1799 return VLC_SUCCESS;