1 /*****************************************************************************
2 * media.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 *****************************************************************************/
30 #include <vlc/libvlc.h>
31 #include <vlc/libvlc_media.h>
32 #include <vlc/libvlc_media_list.h> // For the subitems, here for convenience
33 #include <vlc/libvlc_events.h>
35 #include <vlc_common.h>
36 #include <vlc_input.h>
38 #include <vlc_playlist.h> /* For the preparser */
43 #include "libvlc_internal.h"
44 #include "media_internal.h"
46 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
48 [libvlc_meta_Title] = vlc_meta_Title,
49 [libvlc_meta_Artist] = vlc_meta_Artist,
50 [libvlc_meta_Genre] = vlc_meta_Genre,
51 [libvlc_meta_Copyright] = vlc_meta_Copyright,
52 [libvlc_meta_Album] = vlc_meta_Album,
53 [libvlc_meta_TrackNumber] = vlc_meta_TrackNumber,
54 [libvlc_meta_Description] = vlc_meta_Description,
55 [libvlc_meta_Rating] = vlc_meta_Rating,
56 [libvlc_meta_Date] = vlc_meta_Date,
57 [libvlc_meta_Setting] = vlc_meta_Setting,
58 [libvlc_meta_URL] = vlc_meta_URL,
59 [libvlc_meta_Language] = vlc_meta_Language,
60 [libvlc_meta_NowPlaying] = vlc_meta_NowPlaying,
61 [libvlc_meta_Publisher] = vlc_meta_Publisher,
62 [libvlc_meta_EncodedBy] = vlc_meta_EncodedBy,
63 [libvlc_meta_ArtworkURL] = vlc_meta_ArtworkURL,
64 [libvlc_meta_TrackID] = vlc_meta_TrackID
67 static const libvlc_meta_t vlc_to_libvlc_meta[] =
69 [vlc_meta_Title] = libvlc_meta_Title,
70 [vlc_meta_Artist] = libvlc_meta_Artist,
71 [vlc_meta_Genre] = libvlc_meta_Genre,
72 [vlc_meta_Copyright] = libvlc_meta_Copyright,
73 [vlc_meta_Album] = libvlc_meta_Album,
74 [vlc_meta_TrackNumber] = libvlc_meta_TrackNumber,
75 [vlc_meta_Description] = libvlc_meta_Description,
76 [vlc_meta_Rating] = libvlc_meta_Rating,
77 [vlc_meta_Date] = libvlc_meta_Date,
78 [vlc_meta_Setting] = libvlc_meta_Setting,
79 [vlc_meta_URL] = libvlc_meta_URL,
80 [vlc_meta_Language] = libvlc_meta_Language,
81 [vlc_meta_NowPlaying] = libvlc_meta_NowPlaying,
82 [vlc_meta_Publisher] = libvlc_meta_Publisher,
83 [vlc_meta_EncodedBy] = libvlc_meta_EncodedBy,
84 [vlc_meta_ArtworkURL] = libvlc_meta_ArtworkURL,
85 [vlc_meta_TrackID] = libvlc_meta_TrackID
88 /**************************************************************************
89 * input_item_subitem_added (Private) (vlc event Callback)
90 **************************************************************************/
91 static void input_item_subitem_added( const vlc_event_t *p_event,
94 libvlc_media_t * p_md = user_data;
95 libvlc_media_t * p_md_child;
98 p_md_child = libvlc_media_new_from_input_item(
99 p_md->p_libvlc_instance,
100 p_event->u.input_item_subitem_added.p_new_child );
102 /* Add this to our media list */
103 if( !p_md->p_subitems )
105 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
106 libvlc_media_list_set_media( p_md->p_subitems, p_md );
108 if( p_md->p_subitems )
110 libvlc_media_list_add_media( p_md->p_subitems, p_md_child );
113 /* Construct the event */
114 event.type = libvlc_MediaSubItemAdded;
115 event.u.media_subitem_added.new_child = p_md_child;
118 libvlc_event_send( p_md->p_event_manager, &event );
119 libvlc_media_release( p_md_child );
122 /**************************************************************************
123 * input_item_meta_changed (Private) (vlc event Callback)
124 **************************************************************************/
125 static void input_item_meta_changed( const vlc_event_t *p_event,
128 libvlc_media_t * p_md = user_data;
129 libvlc_event_t event;
131 /* Construct the event */
132 event.type = libvlc_MediaMetaChanged;
133 event.u.media_meta_changed.meta_type =
134 vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
137 libvlc_event_send( p_md->p_event_manager, &event );
140 /**************************************************************************
141 * input_item_duration_changed (Private) (vlc event Callback)
142 **************************************************************************/
143 static void input_item_duration_changed( const vlc_event_t *p_event,
146 libvlc_media_t * p_md = user_data;
147 libvlc_event_t event;
149 /* Construct the event */
150 event.type = libvlc_MediaDurationChanged;
151 event.u.media_duration_changed.new_duration =
152 from_mtime(p_event->u.input_item_duration_changed.new_duration);
155 libvlc_event_send( p_md->p_event_manager, &event );
158 /**************************************************************************
159 * input_item_preparsed_changed (Private) (vlc event Callback)
160 **************************************************************************/
161 static void input_item_preparsed_changed( const vlc_event_t *p_event,
164 libvlc_media_t * p_md = user_data;
165 libvlc_event_t event;
167 /* Construct the event */
168 event.type = libvlc_MediaPreparsedChanged;
169 event.u.media_preparsed_changed.new_status =
170 p_event->u.input_item_preparsed_changed.new_status;
173 libvlc_event_send( p_md->p_event_manager, &event );
176 /**************************************************************************
177 * Install event handler (Private)
178 **************************************************************************/
179 static void install_input_item_observer( libvlc_media_t *p_md )
181 vlc_event_attach( &p_md->p_input_item->event_manager,
182 vlc_InputItemSubItemAdded,
183 input_item_subitem_added,
185 vlc_event_attach( &p_md->p_input_item->event_manager,
186 vlc_InputItemMetaChanged,
187 input_item_meta_changed,
189 vlc_event_attach( &p_md->p_input_item->event_manager,
190 vlc_InputItemDurationChanged,
191 input_item_duration_changed,
193 vlc_event_attach( &p_md->p_input_item->event_manager,
194 vlc_InputItemPreparsedChanged,
195 input_item_preparsed_changed,
199 /**************************************************************************
200 * Uninstall event handler (Private)
201 **************************************************************************/
202 static void uninstall_input_item_observer( libvlc_media_t *p_md )
204 vlc_event_detach( &p_md->p_input_item->event_manager,
205 vlc_InputItemSubItemAdded,
206 input_item_subitem_added,
208 vlc_event_detach( &p_md->p_input_item->event_manager,
209 vlc_InputItemMetaChanged,
210 input_item_meta_changed,
212 vlc_event_detach( &p_md->p_input_item->event_manager,
213 vlc_InputItemDurationChanged,
214 input_item_duration_changed,
216 vlc_event_detach( &p_md->p_input_item->event_manager,
217 vlc_InputItemPreparsedChanged,
218 input_item_preparsed_changed,
222 /**************************************************************************
223 * Preparse if not already done (Private)
224 **************************************************************************/
225 static void preparse_if_needed( libvlc_media_t *p_md )
227 /* XXX: need some locking here */
228 if (!p_md->b_preparsed)
230 playlist_PreparseEnqueue(
231 libvlc_priv (p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
232 p_md->p_input_item );
233 p_md->b_preparsed = true;
237 /**************************************************************************
238 * Create a new media descriptor object from an input_item
240 * That's the generic constructor
241 **************************************************************************/
242 libvlc_media_t * libvlc_media_new_from_input_item(
243 libvlc_instance_t *p_instance,
244 input_item_t *p_input_item )
246 libvlc_media_t * p_md;
250 libvlc_printerr( "No input item given" );
254 p_md = calloc( 1, sizeof(libvlc_media_t) );
257 libvlc_printerr( "Not enough memory" );
261 p_md->p_libvlc_instance = p_instance;
262 p_md->p_input_item = p_input_item;
263 p_md->i_refcount = 1;
265 p_md->state = libvlc_NothingSpecial;
267 /* A media descriptor can be a playlist. When you open a playlist
268 * It can give a bunch of item to read. */
269 p_md->p_subitems = NULL;
271 p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance );
272 if( unlikely(p_md->p_event_manager == NULL) )
277 libvlc_event_manager_register_event_type( p_md->p_event_manager,
278 libvlc_MediaMetaChanged );
279 libvlc_event_manager_register_event_type( p_md->p_event_manager,
280 libvlc_MediaSubItemAdded );
281 libvlc_event_manager_register_event_type( p_md->p_event_manager,
283 libvlc_event_manager_register_event_type( p_md->p_event_manager,
284 libvlc_MediaDurationChanged );
285 libvlc_event_manager_register_event_type( p_md->p_event_manager,
286 libvlc_MediaStateChanged );
287 libvlc_event_manager_register_event_type( p_md->p_event_manager,
288 libvlc_MediaPreparsedChanged );
290 vlc_gc_incref( p_md->p_input_item );
292 install_input_item_observer( p_md );
297 /**************************************************************************
298 * Create a new media descriptor object
299 **************************************************************************/
300 libvlc_media_t *libvlc_media_new_location( libvlc_instance_t *p_instance,
301 const char * psz_mrl )
303 input_item_t * p_input_item;
304 libvlc_media_t * p_md;
306 p_input_item = input_item_New( p_instance->p_libvlc_int, psz_mrl, NULL );
310 libvlc_printerr( "Not enough memory" );
314 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
316 /* The p_input_item is retained in libvlc_media_new_from_input_item */
317 vlc_gc_decref( p_input_item );
322 libvlc_media_t *libvlc_media_new_path( libvlc_instance_t *p_instance,
325 char *mrl = make_URI( path );
326 if( unlikely(mrl == NULL) )
328 libvlc_printerr( "Not enough memory" );
332 libvlc_media_t *m = libvlc_media_new_location( p_instance, mrl );
337 /**************************************************************************
338 * Create a new media descriptor object
339 **************************************************************************/
340 libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance,
341 const char * psz_name )
343 input_item_t * p_input_item;
344 libvlc_media_t * p_md;
346 p_input_item = input_item_New( p_instance->p_libvlc_int, "vlc://nop", psz_name );
350 libvlc_printerr( "Not enough memory" );
354 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
356 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
361 /**************************************************************************
362 * Add an option to the media descriptor,
363 * that will be used to determine how the media_player will read the
364 * media. This allow to use VLC advanced reading/streaming
365 * options in a per-media basis
367 * The options are detailled in vlc --long-help, for instance "--sout-all"
368 **************************************************************************/
369 void libvlc_media_add_option( libvlc_media_t * p_md,
370 const char * psz_option )
372 libvlc_media_add_option_flag( p_md, psz_option,
373 VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
376 /**************************************************************************
377 * Same as libvlc_media_add_option but with configurable flags.
378 **************************************************************************/
379 void libvlc_media_add_option_flag( libvlc_media_t * p_md,
380 const char * ppsz_option,
383 input_item_AddOption( p_md->p_input_item, ppsz_option, i_flags );
386 /**************************************************************************
387 * Delete a media descriptor object
388 **************************************************************************/
389 void libvlc_media_release( libvlc_media_t *p_md )
396 if( p_md->i_refcount > 0 )
399 if( p_md->p_subitems )
400 libvlc_media_list_release( p_md->p_subitems );
402 uninstall_input_item_observer( p_md );
403 vlc_gc_decref( p_md->p_input_item );
405 /* Construct the event */
406 libvlc_event_t event;
407 event.type = libvlc_MediaFreed;
408 event.u.media_freed.md = p_md;
411 libvlc_event_send( p_md->p_event_manager, &event );
413 libvlc_event_manager_release( p_md->p_event_manager );
418 /**************************************************************************
419 * Retain a media descriptor object
420 **************************************************************************/
421 void libvlc_media_retain( libvlc_media_t *p_md )
427 /**************************************************************************
428 * Duplicate a media descriptor object
429 **************************************************************************/
431 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
433 return libvlc_media_new_from_input_item(
434 p_md_orig->p_libvlc_instance, p_md_orig->p_input_item );
437 /**************************************************************************
438 * Get mrl from a media descriptor object
439 **************************************************************************/
441 libvlc_media_get_mrl( libvlc_media_t * p_md )
444 return input_item_GetURI( p_md->p_input_item );
447 /**************************************************************************
448 * Getter for meta information
449 **************************************************************************/
451 char *libvlc_media_get_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta )
458 preparse_if_needed( p_md );
460 psz_meta = input_item_GetMeta( p_md->p_input_item,
461 libvlc_to_vlc_meta[e_meta] );
463 if( e_meta == libvlc_meta_ArtworkURL && !psz_meta && !p_md->has_asked_art )
465 p_md->has_asked_art = true;
466 playlist_AskForArtEnqueue(
467 libvlc_priv(p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
468 p_md->p_input_item );
471 /* Should be integrated in core */
472 if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
475 return strdup( p_md->p_input_item->psz_name );
481 /**************************************************************************
482 * Setter for meta information
483 **************************************************************************/
485 void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, const char *psz_value )
488 input_item_SetMeta( p_md->p_input_item, libvlc_to_vlc_meta[e_meta], psz_value );
491 int libvlc_media_save_meta( libvlc_media_t *p_md )
494 vlc_object_t *p_obj = VLC_OBJECT(libvlc_priv(
495 p_md->p_libvlc_instance->p_libvlc_int)->p_playlist);
496 return input_item_WriteMeta( p_obj, p_md->p_input_item ) == VLC_SUCCESS;
499 /**************************************************************************
500 * Getter for state information
501 * Can be error, playing, buffering, NothingSpecial.
502 **************************************************************************/
505 libvlc_media_get_state( libvlc_media_t *p_md )
511 /**************************************************************************
512 * Setter for state information (LibVLC Internal)
513 **************************************************************************/
516 libvlc_media_set_state( libvlc_media_t *p_md,
517 libvlc_state_t state )
519 libvlc_event_t event;
523 /* Construct the event */
524 event.type = libvlc_MediaStateChanged;
525 event.u.media_state_changed.new_state = state;
528 libvlc_event_send( p_md->p_event_manager, &event );
531 /**************************************************************************
533 **************************************************************************/
534 libvlc_media_list_t *
535 libvlc_media_subitems( libvlc_media_t * p_md )
537 if( p_md->p_subitems )
538 libvlc_media_list_retain( p_md->p_subitems );
539 return p_md->p_subitems;
542 /**************************************************************************
543 * Getter for statistics information
544 **************************************************************************/
545 int libvlc_media_get_stats( libvlc_media_t *p_md,
546 libvlc_media_stats_t *p_stats )
548 if( !p_md->p_input_item )
551 input_stats_t *p_itm_stats = p_md->p_input_item->p_stats;
552 vlc_mutex_lock( &p_itm_stats->lock );
553 p_stats->i_read_bytes = p_itm_stats->i_read_bytes;
554 p_stats->f_input_bitrate = p_itm_stats->f_input_bitrate;
556 p_stats->i_demux_read_bytes = p_itm_stats->i_demux_read_bytes;
557 p_stats->f_demux_bitrate = p_itm_stats->f_demux_bitrate;
558 p_stats->i_demux_corrupted = p_itm_stats->i_demux_corrupted;
559 p_stats->i_demux_discontinuity = p_itm_stats->i_demux_discontinuity;
561 p_stats->i_decoded_video = p_itm_stats->i_decoded_video;
562 p_stats->i_decoded_audio = p_itm_stats->i_decoded_audio;
564 p_stats->i_displayed_pictures = p_itm_stats->i_displayed_pictures;
565 p_stats->i_lost_pictures = p_itm_stats->i_lost_pictures;
567 p_stats->i_played_abuffers = p_itm_stats->i_played_abuffers;
568 p_stats->i_lost_abuffers = p_itm_stats->i_lost_abuffers;
570 p_stats->i_sent_packets = p_itm_stats->i_sent_packets;
571 p_stats->i_sent_bytes = p_itm_stats->i_sent_bytes;
572 p_stats->f_send_bitrate = p_itm_stats->f_send_bitrate;
573 vlc_mutex_unlock( &p_itm_stats->lock );
577 /**************************************************************************
579 **************************************************************************/
580 libvlc_event_manager_t *
581 libvlc_media_event_manager( libvlc_media_t * p_md )
585 return p_md->p_event_manager;
588 /**************************************************************************
589 * Get duration of media object (in ms)
590 **************************************************************************/
592 libvlc_media_get_duration( libvlc_media_t * p_md )
596 if( !p_md->p_input_item )
598 libvlc_printerr( "No input item" );
602 preparse_if_needed( p_md );
604 if (!input_item_IsPreparsed( p_md->p_input_item ))
607 return from_mtime(input_item_GetDuration( p_md->p_input_item ));
610 /**************************************************************************
611 * Get preparsed status for media object.
612 **************************************************************************/
614 libvlc_media_is_preparsed( libvlc_media_t * p_md )
618 if( !p_md->p_input_item )
621 return input_item_IsPreparsed( p_md->p_input_item );
624 /**************************************************************************
625 * Sets media descriptor's user_data. user_data is specialized data
626 * accessed by the host application, VLC.framework uses it as a pointer to
627 * an native object that references a libvlc_media_t pointer
628 **************************************************************************/
630 libvlc_media_set_user_data( libvlc_media_t * p_md, void * p_new_user_data )
633 p_md->p_user_data = p_new_user_data;
636 /**************************************************************************
637 * Get media descriptor's user_data. user_data is specialized data
638 * accessed by the host application, VLC.framework uses it as a pointer to
639 * an native object that references a libvlc_media_t pointer
640 **************************************************************************/
642 libvlc_media_get_user_data( libvlc_media_t * p_md )
645 return p_md->p_user_data;
648 /**************************************************************************
649 * Get media descriptor's elementary streams description
650 **************************************************************************/
652 libvlc_media_get_es( libvlc_media_t *p_md, libvlc_media_es_t ** pp_es )
656 input_item_t *p_input_item = p_md->p_input_item;
657 vlc_mutex_lock( &p_input_item->lock );
659 const int i_es = p_input_item->i_es;
660 *pp_es = (i_es > 0) ? malloc( i_es * sizeof(libvlc_media_es_t) ) : NULL;
662 if( !pp_es ) /* no ES, or OOM */
664 vlc_mutex_unlock( &p_input_item->lock );
669 for( int i = 0; i < i_es; i++ )
671 libvlc_media_es_t *p_mes = *pp_es+i;
672 const es_format_t *p_es = p_input_item->es[i];
674 p_mes->i_channels = p_mes->i_rate = 0;
675 p_mes->i_width = p_mes->i_height = 0;
678 p_mes->i_codec = p_es->i_codec;
679 p_mes->i_id = p_es->i_id;
681 p_mes->i_profile = p_es->i_profile;
682 p_mes->i_level = p_es->i_level;
688 p_mes->i_type = libvlc_es_unknown;
691 p_mes->i_type = libvlc_es_video;
692 p_mes->i_height = p_es->video.i_height;
693 p_mes->i_width = p_es->video.i_width;
696 p_mes->i_type = libvlc_es_audio;
697 p_mes->i_channels = p_es->audio.i_channels;
698 p_mes->i_rate = p_es->audio.i_rate;
701 p_mes->i_type = libvlc_es_text;
706 vlc_mutex_unlock( &p_input_item->lock );