1 /*****************************************************************************
2 * media_descriptor.c: Libvlc API media descripor management
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Pierre d'Herbemont <pdherbemont@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 *****************************************************************************/
24 #include "libvlc_internal.h"
26 #include <vlc/libvlc.h>
27 #include <vlc_input.h>
30 /* For the preparser */
31 #include <vlc_playlist.h>
33 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
35 [libvlc_meta_Title] = vlc_meta_Title,
36 [libvlc_meta_Artist] = vlc_meta_Artist,
37 [libvlc_meta_Genre] = vlc_meta_Genre,
38 [libvlc_meta_Copyright] = vlc_meta_Copyright,
39 [libvlc_meta_Album] = vlc_meta_Album,
40 [libvlc_meta_TrackNumber] = vlc_meta_TrackNumber,
41 [libvlc_meta_Description] = vlc_meta_Description,
42 [libvlc_meta_Rating] = vlc_meta_Rating,
43 [libvlc_meta_Date] = vlc_meta_Date,
44 [libvlc_meta_Setting] = vlc_meta_Setting,
45 [libvlc_meta_URL] = vlc_meta_URL,
46 [libvlc_meta_Language] = vlc_meta_Language,
47 [libvlc_meta_NowPlaying] = vlc_meta_NowPlaying,
48 [libvlc_meta_Publisher] = vlc_meta_Publisher,
49 [libvlc_meta_EncodedBy] = vlc_meta_EncodedBy,
50 [libvlc_meta_ArtworkURL] = vlc_meta_ArtworkURL,
51 [libvlc_meta_TrackID] = vlc_meta_TrackID
54 static const libvlc_meta_t vlc_to_libvlc_meta[] =
56 [vlc_meta_Title] = libvlc_meta_Title,
57 [vlc_meta_Artist] = libvlc_meta_Artist,
58 [vlc_meta_Genre] = libvlc_meta_Genre,
59 [vlc_meta_Copyright] = libvlc_meta_Copyright,
60 [vlc_meta_Album] = libvlc_meta_Album,
61 [vlc_meta_TrackNumber] = libvlc_meta_TrackNumber,
62 [vlc_meta_Description] = libvlc_meta_Description,
63 [vlc_meta_Rating] = libvlc_meta_Rating,
64 [vlc_meta_Date] = libvlc_meta_Date,
65 [vlc_meta_Setting] = libvlc_meta_Setting,
66 [vlc_meta_URL] = libvlc_meta_URL,
67 [vlc_meta_Language] = libvlc_meta_Language,
68 [vlc_meta_NowPlaying] = libvlc_meta_NowPlaying,
69 [vlc_meta_Publisher] = libvlc_meta_Publisher,
70 [vlc_meta_EncodedBy] = libvlc_meta_EncodedBy,
71 [vlc_meta_ArtworkURL] = libvlc_meta_ArtworkURL,
72 [vlc_meta_TrackID] = libvlc_meta_TrackID
75 /**************************************************************************
76 * input_item_subitem_added (Private) (vlc event Callback)
77 **************************************************************************/
78 static void input_item_subitem_added( const vlc_event_t *p_event,
81 libvlc_media_descriptor_t * p_md = user_data;
82 libvlc_media_descriptor_t * p_md_child;
85 p_md_child = libvlc_media_descriptor_new_from_input_item(
86 p_md->p_libvlc_instance,
87 p_event->u.input_item_subitem_added.p_new_child, NULL );
89 /* Add this to our media list */
90 if( !p_md->p_subitems )
92 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
93 libvlc_media_list_set_media_descriptor( p_md->p_subitems, p_md, NULL );
95 if( p_md->p_subitems )
97 libvlc_media_list_add_media_descriptor( p_md->p_subitems, p_md_child, NULL );
100 /* Construct the event */
101 event.type = libvlc_MediaDescriptorSubItemAdded;
102 event.u.media_descriptor_subitem_added.new_child = p_md_child;
105 libvlc_event_send( p_md->p_event_manager, &event );
106 libvlc_media_descriptor_release( p_md_child );
109 /**************************************************************************
110 * input_item_meta_changed (Private) (vlc event Callback)
111 **************************************************************************/
112 static void input_item_meta_changed( const vlc_event_t *p_event,
115 libvlc_media_descriptor_t * p_md = user_data;
116 libvlc_event_t event;
118 /* Construct the event */
119 event.type = libvlc_MediaDescriptorMetaChanged;
120 event.u.media_descriptor_meta_changed.meta_type =
121 vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
124 libvlc_event_send( p_md->p_event_manager, &event );
127 /**************************************************************************
128 * input_item_duration_changed (Private) (vlc event Callback)
129 **************************************************************************/
130 static void input_item_duration_changed( const vlc_event_t *p_event,
133 libvlc_media_descriptor_t * p_md = user_data;
134 libvlc_event_t event;
136 /* Construct the event */
137 event.type = libvlc_MediaDescriptorDurationChanged;
138 event.u.media_descriptor_duration_changed.new_duration =
139 p_event->u.input_item_duration_changed.new_duration;
142 libvlc_event_send( p_md->p_event_manager, &event );
145 /**************************************************************************
146 * input_item_preparsed_changed (Private) (vlc event Callback)
147 **************************************************************************/
148 static void input_item_preparsed_changed( const vlc_event_t *p_event,
151 libvlc_media_descriptor_t * p_md = user_data;
152 libvlc_event_t event;
154 /* Construct the event */
155 event.type = libvlc_MediaDescriptorPreparsedChanged;
156 event.u.media_descriptor_preparsed_changed.new_status =
157 p_event->u.input_item_preparsed_changed.new_status;
160 libvlc_event_send( p_md->p_event_manager, &event );
163 /**************************************************************************
164 * Install event handler (Private)
165 **************************************************************************/
166 static void install_input_item_observer( libvlc_media_descriptor_t *p_md )
168 vlc_event_attach( &p_md->p_input_item->event_manager,
169 vlc_InputItemSubItemAdded,
170 input_item_subitem_added,
172 vlc_event_attach( &p_md->p_input_item->event_manager,
173 vlc_InputItemMetaChanged,
174 input_item_meta_changed,
176 vlc_event_attach( &p_md->p_input_item->event_manager,
177 vlc_InputItemDurationChanged,
178 input_item_duration_changed,
180 vlc_event_attach( &p_md->p_input_item->event_manager,
181 vlc_InputItemPreparsedChanged,
182 input_item_preparsed_changed,
186 /**************************************************************************
187 * Uninstall event handler (Private)
188 **************************************************************************/
189 static void uninstall_input_item_observer( libvlc_media_descriptor_t *p_md )
191 vlc_event_detach( &p_md->p_input_item->event_manager,
192 vlc_InputItemSubItemAdded,
193 input_item_subitem_added,
195 vlc_event_detach( &p_md->p_input_item->event_manager,
196 vlc_InputItemMetaChanged,
197 input_item_meta_changed,
199 vlc_event_detach( &p_md->p_input_item->event_manager,
200 vlc_InputItemDurationChanged,
201 input_item_duration_changed,
203 vlc_event_detach( &p_md->p_input_item->event_manager,
204 vlc_InputItemPreparsedChanged,
205 input_item_preparsed_changed,
209 /**************************************************************************
210 * Preparse if not already done (Private)
211 **************************************************************************/
212 static void preparse_if_needed( libvlc_media_descriptor_t *p_md )
214 /* XXX: need some locking here */
215 if (!p_md->b_preparsed)
217 playlist_PreparseEnqueue(
218 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
219 p_md->p_input_item );
220 p_md->b_preparsed = VLC_TRUE;
224 /**************************************************************************
225 * Create a new media descriptor object from an input_item
227 * That's the generic constructor
228 **************************************************************************/
229 libvlc_media_descriptor_t * libvlc_media_descriptor_new_from_input_item(
230 libvlc_instance_t *p_instance,
231 input_item_t *p_input_item,
232 libvlc_exception_t *p_e )
234 libvlc_media_descriptor_t * p_md;
238 libvlc_exception_raise( p_e, "No input item given" );
242 p_md = malloc( sizeof(libvlc_media_descriptor_t) );
243 p_md->p_libvlc_instance = p_instance;
244 p_md->p_input_item = p_input_item;
245 p_md->b_preparsed = VLC_FALSE;
246 p_md->i_refcount = 1;
247 p_md->p_user_data = NULL;
249 p_md->state = libvlc_NothingSpecial;
251 /* A media descriptor can be a playlist. When you open a playlist
252 * It can give a bunch of item to read. */
253 p_md->p_subitems = NULL;
255 vlc_dictionary_init( &p_md->tags, 1 );
257 p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance, p_e );
258 libvlc_event_manager_register_event_type( p_md->p_event_manager,
259 libvlc_MediaDescriptorMetaChanged, p_e );
260 libvlc_event_manager_register_event_type( p_md->p_event_manager,
261 libvlc_MediaDescriptorSubItemAdded, p_e );
262 libvlc_event_manager_register_event_type( p_md->p_event_manager,
263 libvlc_MediaDescriptorFreed, p_e );
264 libvlc_event_manager_register_event_type( p_md->p_event_manager,
265 libvlc_MediaDescriptorDurationChanged, p_e );
266 libvlc_event_manager_register_event_type( p_md->p_event_manager,
267 libvlc_MediaDescriptorStateChanged, p_e );
269 vlc_gc_incref( p_md->p_input_item );
271 install_input_item_observer( p_md );
276 /**************************************************************************
277 * Create a new media descriptor object
278 **************************************************************************/
279 libvlc_media_descriptor_t * libvlc_media_descriptor_new(
280 libvlc_instance_t *p_instance,
281 const char * psz_mrl,
282 libvlc_exception_t *p_e )
284 input_item_t * p_input_item;
285 libvlc_media_descriptor_t * p_md;
287 p_input_item = input_ItemNew( p_instance->p_libvlc_int, psz_mrl, NULL );
291 libvlc_exception_raise( p_e, "Can't create md's input_item" );
295 p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
298 /* The p_input_item is retained in libvlc_media_descriptor_new_from_input_item */
299 vlc_gc_decref( p_input_item );
304 /**************************************************************************
305 * Create a new media descriptor object
306 **************************************************************************/
307 libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
308 libvlc_instance_t *p_instance,
309 const char * psz_name,
310 libvlc_exception_t *p_e )
312 input_item_t * p_input_item;
313 libvlc_media_descriptor_t * p_md;
315 p_input_item = input_ItemNew( p_instance->p_libvlc_int, "vlc:nop", psz_name );
319 libvlc_exception_raise( p_e, "Can't create md's input_item" );
323 p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
326 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
331 /**************************************************************************
332 * Add an option to the media descriptor,
333 * that will be used to determine how the media_instance will read the
334 * media_descriptor. This allow to use VLC advanced reading/streaming
335 * options in a per-media basis
337 * The options are detailled in vlc --long-help, for instance "--sout-all"
338 **************************************************************************/
339 void libvlc_media_descriptor_add_option(
340 libvlc_media_descriptor_t * p_md,
341 const char * ppsz_option,
342 libvlc_exception_t *p_e )
345 input_ItemAddOpt( p_md->p_input_item, ppsz_option,
346 VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
349 /**************************************************************************
350 * Delete a media descriptor object
351 **************************************************************************/
352 void libvlc_media_descriptor_release( libvlc_media_descriptor_t *p_md )
360 if( p_md->i_refcount > 0 )
363 if( p_md->p_subitems )
364 libvlc_media_list_release( p_md->p_subitems );
366 uninstall_input_item_observer( p_md );
367 vlc_gc_decref( p_md->p_input_item );
369 /* Construct the event */
370 libvlc_event_t event;
371 event.type = libvlc_MediaDescriptorFreed;
372 event.u.media_descriptor_freed.md = p_md;
375 libvlc_event_send( p_md->p_event_manager, &event );
377 libvlc_event_manager_release( p_md->p_event_manager );
379 char ** all_keys = vlc_dictionary_all_keys( &p_md->tags );
380 for( i = 0; all_keys[i]; i++ )
383 struct libvlc_tags_storage_t * p_ts = vlc_dictionary_value_for_key( &p_md->tags, all_keys[i] );
384 for( j = 0; j < p_ts->i_count; j++ )
386 free( p_ts->ppsz_tags[j] );
387 free( p_ts->ppsz_tags );
391 vlc_dictionary_clear( &p_md->tags );
395 /**************************************************************************
396 * Retain a media descriptor object
397 **************************************************************************/
398 void libvlc_media_descriptor_retain( libvlc_media_descriptor_t *p_md )
406 /**************************************************************************
407 * Duplicate a media descriptor object
408 **************************************************************************/
409 libvlc_media_descriptor_t *
410 libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t *p_md_orig )
412 return libvlc_media_descriptor_new_from_input_item(
413 p_md_orig->p_libvlc_instance, p_md_orig->p_input_item, NULL );
416 /**************************************************************************
417 * Retain a media descriptor object
418 **************************************************************************/
420 libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
421 libvlc_exception_t * p_e )
424 return input_item_GetURI( p_md->p_input_item );
427 /**************************************************************************
428 * Getter for meta information
429 **************************************************************************/
431 char * libvlc_media_descriptor_get_meta( libvlc_media_descriptor_t *p_md,
432 libvlc_meta_t e_meta,
433 libvlc_exception_t *p_e )
441 preparse_if_needed( p_md );
443 psz_meta = input_item_GetMeta( p_md->p_input_item,
444 libvlc_to_vlc_meta[e_meta] );
446 if( e_meta == libvlc_meta_ArtworkURL && !psz_meta )
448 playlist_AskForArtEnqueue(
449 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
450 p_md->p_input_item );
453 /* Should be integrated in core */
454 if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
457 return strdup( p_md->p_input_item->psz_name );
463 /**************************************************************************
464 * Getter for state information
465 * Can be error, playing, buffering, NothingSpecial.
466 **************************************************************************/
469 libvlc_media_descriptor_get_state( libvlc_media_descriptor_t *p_md,
470 libvlc_exception_t *p_e )
476 /**************************************************************************
477 * Setter for state information (LibVLC Internal)
478 **************************************************************************/
481 libvlc_media_descriptor_set_state( libvlc_media_descriptor_t *p_md,
482 libvlc_state_t state,
483 libvlc_exception_t *p_e )
486 libvlc_event_t event;
490 /* Construct the event */
491 event.type = libvlc_MediaDescriptorStateChanged;
492 event.u.media_descriptor_state_changed.new_state = state;
495 libvlc_event_send( p_md->p_event_manager, &event );
498 /**************************************************************************
500 **************************************************************************/
501 void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
503 const libvlc_tag_t tag,
504 libvlc_exception_t *p_e )
508 struct libvlc_tags_storage_t * p_ts;
513 p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
517 p_ts = malloc(sizeof(struct libvlc_tags_storage_t));
518 memset( p_ts, 0, sizeof(struct libvlc_tags_storage_t) );
522 if( !p_ts->ppsz_tags )
523 p_ts->ppsz_tags = malloc(sizeof(char*)*(p_ts->i_count));
525 p_ts->ppsz_tags = realloc(p_ts->ppsz_tags, sizeof(char*)*(p_ts->i_count));
527 p_ts->ppsz_tags[p_ts->i_count-1] = strdup( tag );
531 /**************************************************************************
533 **************************************************************************/
534 void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
536 const libvlc_tag_t tag,
537 libvlc_exception_t *p_e )
541 struct libvlc_tags_storage_t * p_ts;
547 p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
552 for( i = 0; i < p_ts->i_count; i++ )
554 if( !strcmp( p_ts->ppsz_tags[i], tag ) )
556 free( p_ts->ppsz_tags[i] );
557 memcpy( p_ts->ppsz_tags + i + 1, p_ts->ppsz_tags + i, (p_ts->i_count - i - 2)*sizeof(char*) );
558 /* Don't dealloc, the memory will be regain if we add a new tag */
565 /**************************************************************************
567 **************************************************************************/
568 int libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
570 libvlc_exception_t *p_e )
574 struct libvlc_tags_storage_t * p_ts;
579 p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
583 return p_ts->i_count;
586 /**************************************************************************
588 **************************************************************************/
590 libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
593 libvlc_exception_t *p_e )
597 struct libvlc_tags_storage_t * p_ts;
602 p_ts = vlc_dictionary_value_for_key( &p_md->tags, key );
607 return strdup( p_ts->ppsz_tags[i] );
610 /**************************************************************************
612 **************************************************************************/
613 libvlc_media_list_t *
614 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t * p_md,
615 libvlc_exception_t * p_e )
619 if( p_md->p_subitems )
620 libvlc_media_list_retain( p_md->p_subitems );
621 return p_md->p_subitems;
624 /**************************************************************************
626 **************************************************************************/
627 libvlc_event_manager_t *
628 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
629 libvlc_exception_t * p_e )
633 return p_md->p_event_manager;
636 /**************************************************************************
637 * Get duration of media_descriptor object.
638 **************************************************************************/
640 libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
641 libvlc_exception_t * p_e )
645 if( p_md && p_md->p_input_item)
647 return input_item_GetDuration( p_md->p_input_item );
655 /**************************************************************************
656 * Get preparsed status for media_descriptor object.
657 **************************************************************************/
659 libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
660 libvlc_exception_t * p_e )
664 if( p_md && p_md->p_input_item)
666 return input_item_IsPreparsed( p_md->p_input_item );
674 /**************************************************************************
675 * Sets media descriptor's user_data. user_data is specialized data
676 * accessed by the host application, VLC.framework uses it as a pointer to
677 * an native object that references a libvlc_media_descriptor_t pointer
678 **************************************************************************/
680 libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
681 void * p_new_user_data,
682 libvlc_exception_t * p_e )
688 p_md->p_user_data = p_new_user_data;
692 /**************************************************************************
693 * Get media descriptor's user_data. user_data is specialized data
694 * accessed by the host application, VLC.framework uses it as a pointer to
695 * an native object that references a libvlc_media_descriptor_t pointer
696 **************************************************************************/
698 libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
699 libvlc_exception_t * p_e )
705 return p_md->p_user_data;