make_URI: add scheme parameter
[vlc/asuraparaju-public.git] / src / control / media.c
blob3f39841bd785178383c386cbd6a5f11e6156e822
1 /*****************************************************************************
2 * media.c: Libvlc API media descripor management
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
5 * $Id$
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 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
28 #include <assert.h>
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>
37 #include <vlc_meta.h>
38 #include <vlc_playlist.h> /* For the preparser */
39 #include <vlc_url.h>
41 #include "libvlc.h"
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,
92 void * user_data )
94 libvlc_media_t * p_md = user_data;
95 libvlc_media_t * p_md_child;
96 libvlc_event_t event;
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;
117 /* Send the event */
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,
126 void * user_data )
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];
136 /* Send the event */
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,
144 void * user_data )
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);
154 /* Send the event */
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,
162 void * user_data)
164 libvlc_media_t *media = user_data;
165 libvlc_event_t event;
167 /* Eventually notify libvlc_media_parse() */
168 vlc_mutex_lock(&media->parsed_lock);
169 media->is_parsed = true;
170 vlc_cond_broadcast(&media->parsed_cond);
171 vlc_mutex_unlock(&media->parsed_lock);
174 /* Construct the event */
175 event.type = libvlc_MediaParsedChanged;
176 event.u.media_parsed_changed.new_status =
177 p_event->u.input_item_preparsed_changed.new_status;
179 /* Send the event */
180 libvlc_event_send(media->p_event_manager, &event);
183 /**************************************************************************
184 * Install event handler (Private)
185 **************************************************************************/
186 static void install_input_item_observer( libvlc_media_t *p_md )
188 vlc_event_attach( &p_md->p_input_item->event_manager,
189 vlc_InputItemSubItemAdded,
190 input_item_subitem_added,
191 p_md );
192 vlc_event_attach( &p_md->p_input_item->event_manager,
193 vlc_InputItemMetaChanged,
194 input_item_meta_changed,
195 p_md );
196 vlc_event_attach( &p_md->p_input_item->event_manager,
197 vlc_InputItemDurationChanged,
198 input_item_duration_changed,
199 p_md );
200 vlc_event_attach( &p_md->p_input_item->event_manager,
201 vlc_InputItemPreparsedChanged,
202 input_item_preparsed_changed,
203 p_md );
206 /**************************************************************************
207 * Uninstall event handler (Private)
208 **************************************************************************/
209 static void uninstall_input_item_observer( libvlc_media_t *p_md )
211 vlc_event_detach( &p_md->p_input_item->event_manager,
212 vlc_InputItemSubItemAdded,
213 input_item_subitem_added,
214 p_md );
215 vlc_event_detach( &p_md->p_input_item->event_manager,
216 vlc_InputItemMetaChanged,
217 input_item_meta_changed,
218 p_md );
219 vlc_event_detach( &p_md->p_input_item->event_manager,
220 vlc_InputItemDurationChanged,
221 input_item_duration_changed,
222 p_md );
223 vlc_event_detach( &p_md->p_input_item->event_manager,
224 vlc_InputItemPreparsedChanged,
225 input_item_preparsed_changed,
226 p_md );
229 /**************************************************************************
230 * Preparse if not already done (Private)
231 **************************************************************************/
232 static void preparse_if_needed( libvlc_media_t *p_md )
234 /* XXX: need some locking here */
235 if (!p_md->has_asked_preparse)
237 playlist_PreparseEnqueue(
238 libvlc_priv (p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
239 p_md->p_input_item );
240 p_md->has_asked_preparse = true;
244 /**************************************************************************
245 * Create a new media descriptor object from an input_item
246 * (libvlc internal)
247 * That's the generic constructor
248 **************************************************************************/
249 libvlc_media_t * libvlc_media_new_from_input_item(
250 libvlc_instance_t *p_instance,
251 input_item_t *p_input_item )
253 libvlc_media_t * p_md;
255 if (!p_input_item)
257 libvlc_printerr( "No input item given" );
258 return NULL;
261 p_md = calloc( 1, sizeof(libvlc_media_t) );
262 if( !p_md )
264 libvlc_printerr( "Not enough memory" );
265 return NULL;
268 p_md->p_libvlc_instance = p_instance;
269 p_md->p_input_item = p_input_item;
270 p_md->i_refcount = 1;
272 vlc_cond_init(&p_md->parsed_cond);
273 vlc_mutex_init(&p_md->parsed_lock);
275 p_md->state = libvlc_NothingSpecial;
277 /* A media descriptor can be a playlist. When you open a playlist
278 * It can give a bunch of item to read. */
279 p_md->p_subitems = NULL;
281 p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance );
282 if( unlikely(p_md->p_event_manager == NULL) )
284 free(p_md);
285 return NULL;
288 libvlc_event_manager_t *em = p_md->p_event_manager;
289 libvlc_event_manager_register_event_type(em, libvlc_MediaMetaChanged);
290 libvlc_event_manager_register_event_type(em, libvlc_MediaSubItemAdded);
291 libvlc_event_manager_register_event_type(em, libvlc_MediaFreed);
292 libvlc_event_manager_register_event_type(em, libvlc_MediaDurationChanged);
293 libvlc_event_manager_register_event_type(em, libvlc_MediaStateChanged);
294 libvlc_event_manager_register_event_type(em, libvlc_MediaParsedChanged);
296 vlc_gc_incref( p_md->p_input_item );
298 install_input_item_observer( p_md );
300 return p_md;
303 /**************************************************************************
304 * Create a new media descriptor object
305 **************************************************************************/
306 libvlc_media_t *libvlc_media_new_location( libvlc_instance_t *p_instance,
307 const char * psz_mrl )
309 input_item_t * p_input_item;
310 libvlc_media_t * p_md;
312 p_input_item = input_item_New( p_instance->p_libvlc_int, psz_mrl, NULL );
314 if (!p_input_item)
316 libvlc_printerr( "Not enough memory" );
317 return NULL;
320 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
322 /* The p_input_item is retained in libvlc_media_new_from_input_item */
323 vlc_gc_decref( p_input_item );
325 return p_md;
328 libvlc_media_t *libvlc_media_new_path( libvlc_instance_t *p_instance,
329 const char *path )
331 char *mrl = make_URI( path, "file" );
332 if( unlikely(mrl == NULL) )
334 libvlc_printerr( "Not enough memory" );
335 return NULL;
338 libvlc_media_t *m = libvlc_media_new_location( p_instance, mrl );
339 free( mrl );
340 return m;
343 /**************************************************************************
344 * Create a new media descriptor object
345 **************************************************************************/
346 libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance,
347 const char * psz_name )
349 input_item_t * p_input_item;
350 libvlc_media_t * p_md;
352 p_input_item = input_item_New( p_instance->p_libvlc_int, "vlc://nop", psz_name );
354 if (!p_input_item)
356 libvlc_printerr( "Not enough memory" );
357 return NULL;
360 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
362 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
364 return p_md;
367 /**************************************************************************
368 * Add an option to the media descriptor,
369 * that will be used to determine how the media_player will read the
370 * media. This allow to use VLC advanced reading/streaming
371 * options in a per-media basis
373 * The options are detailled in vlc --long-help, for instance "--sout-all"
374 **************************************************************************/
375 void libvlc_media_add_option( libvlc_media_t * p_md,
376 const char * psz_option )
378 libvlc_media_add_option_flag( p_md, psz_option,
379 VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
382 /**************************************************************************
383 * Same as libvlc_media_add_option but with configurable flags.
384 **************************************************************************/
385 void libvlc_media_add_option_flag( libvlc_media_t * p_md,
386 const char * ppsz_option,
387 unsigned i_flags )
389 input_item_AddOption( p_md->p_input_item, ppsz_option, i_flags );
392 /**************************************************************************
393 * Delete a media descriptor object
394 **************************************************************************/
395 void libvlc_media_release( libvlc_media_t *p_md )
397 if (!p_md)
398 return;
400 p_md->i_refcount--;
402 if( p_md->i_refcount > 0 )
403 return;
405 if( p_md->p_subitems )
406 libvlc_media_list_release( p_md->p_subitems );
408 uninstall_input_item_observer( p_md );
409 vlc_gc_decref( p_md->p_input_item );
411 vlc_cond_destroy( &p_md->parsed_cond );
412 vlc_mutex_destroy( &p_md->parsed_lock );
414 /* Construct the event */
415 libvlc_event_t event;
416 event.type = libvlc_MediaFreed;
417 event.u.media_freed.md = p_md;
419 /* Send the event */
420 libvlc_event_send( p_md->p_event_manager, &event );
422 libvlc_event_manager_release( p_md->p_event_manager );
424 free( p_md );
427 /**************************************************************************
428 * Retain a media descriptor object
429 **************************************************************************/
430 void libvlc_media_retain( libvlc_media_t *p_md )
432 assert (p_md);
433 p_md->i_refcount++;
436 /**************************************************************************
437 * Duplicate a media descriptor object
438 **************************************************************************/
439 libvlc_media_t *
440 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
442 return libvlc_media_new_from_input_item(
443 p_md_orig->p_libvlc_instance, p_md_orig->p_input_item );
446 /**************************************************************************
447 * Get mrl from a media descriptor object
448 **************************************************************************/
449 char *
450 libvlc_media_get_mrl( libvlc_media_t * p_md )
452 assert( p_md );
453 return input_item_GetURI( p_md->p_input_item );
456 /**************************************************************************
457 * Getter for meta information
458 **************************************************************************/
460 char *libvlc_media_get_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta )
462 char * psz_meta;
464 assert( p_md );
465 /* XXX: locking */
467 preparse_if_needed( p_md );
469 psz_meta = input_item_GetMeta( p_md->p_input_item,
470 libvlc_to_vlc_meta[e_meta] );
472 if( e_meta == libvlc_meta_ArtworkURL && !psz_meta && !p_md->has_asked_art )
474 p_md->has_asked_art = true;
475 playlist_AskForArtEnqueue(
476 libvlc_priv(p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
477 p_md->p_input_item );
480 /* Should be integrated in core */
481 if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
483 free( psz_meta );
484 return strdup( p_md->p_input_item->psz_name );
487 return psz_meta;
490 /**************************************************************************
491 * Setter for meta information
492 **************************************************************************/
494 void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, const char *psz_value )
496 assert( p_md );
497 input_item_SetMeta( p_md->p_input_item, libvlc_to_vlc_meta[e_meta], psz_value );
500 int libvlc_media_save_meta( libvlc_media_t *p_md )
502 assert( p_md );
503 vlc_object_t *p_obj = VLC_OBJECT(libvlc_priv(
504 p_md->p_libvlc_instance->p_libvlc_int)->p_playlist);
505 return input_item_WriteMeta( p_obj, p_md->p_input_item ) == VLC_SUCCESS;
508 /**************************************************************************
509 * Getter for state information
510 * Can be error, playing, buffering, NothingSpecial.
511 **************************************************************************/
513 libvlc_state_t
514 libvlc_media_get_state( libvlc_media_t *p_md )
516 assert( p_md );
517 return p_md->state;
520 /**************************************************************************
521 * Setter for state information (LibVLC Internal)
522 **************************************************************************/
524 void
525 libvlc_media_set_state( libvlc_media_t *p_md,
526 libvlc_state_t state )
528 libvlc_event_t event;
530 p_md->state = state;
532 /* Construct the event */
533 event.type = libvlc_MediaStateChanged;
534 event.u.media_state_changed.new_state = state;
536 /* Send the event */
537 libvlc_event_send( p_md->p_event_manager, &event );
540 /**************************************************************************
541 * subitems
542 **************************************************************************/
543 libvlc_media_list_t *
544 libvlc_media_subitems( libvlc_media_t * p_md )
546 if( p_md->p_subitems )
547 libvlc_media_list_retain( p_md->p_subitems );
548 return p_md->p_subitems;
551 /**************************************************************************
552 * Getter for statistics information
553 **************************************************************************/
554 int libvlc_media_get_stats( libvlc_media_t *p_md,
555 libvlc_media_stats_t *p_stats )
557 if( !p_md->p_input_item )
558 return false;
560 input_stats_t *p_itm_stats = p_md->p_input_item->p_stats;
561 vlc_mutex_lock( &p_itm_stats->lock );
562 p_stats->i_read_bytes = p_itm_stats->i_read_bytes;
563 p_stats->f_input_bitrate = p_itm_stats->f_input_bitrate;
565 p_stats->i_demux_read_bytes = p_itm_stats->i_demux_read_bytes;
566 p_stats->f_demux_bitrate = p_itm_stats->f_demux_bitrate;
567 p_stats->i_demux_corrupted = p_itm_stats->i_demux_corrupted;
568 p_stats->i_demux_discontinuity = p_itm_stats->i_demux_discontinuity;
570 p_stats->i_decoded_video = p_itm_stats->i_decoded_video;
571 p_stats->i_decoded_audio = p_itm_stats->i_decoded_audio;
573 p_stats->i_displayed_pictures = p_itm_stats->i_displayed_pictures;
574 p_stats->i_lost_pictures = p_itm_stats->i_lost_pictures;
576 p_stats->i_played_abuffers = p_itm_stats->i_played_abuffers;
577 p_stats->i_lost_abuffers = p_itm_stats->i_lost_abuffers;
579 p_stats->i_sent_packets = p_itm_stats->i_sent_packets;
580 p_stats->i_sent_bytes = p_itm_stats->i_sent_bytes;
581 p_stats->f_send_bitrate = p_itm_stats->f_send_bitrate;
582 vlc_mutex_unlock( &p_itm_stats->lock );
583 return true;
586 /**************************************************************************
587 * event_manager
588 **************************************************************************/
589 libvlc_event_manager_t *
590 libvlc_media_event_manager( libvlc_media_t * p_md )
592 assert( p_md );
594 return p_md->p_event_manager;
597 /**************************************************************************
598 * Get duration of media object (in ms)
599 **************************************************************************/
600 int64_t
601 libvlc_media_get_duration( libvlc_media_t * p_md )
603 assert( p_md );
605 if( !p_md->p_input_item )
607 libvlc_printerr( "No input item" );
608 return -1;
611 preparse_if_needed( p_md );
613 if (!input_item_IsPreparsed( p_md->p_input_item ))
614 return -1;
616 return from_mtime(input_item_GetDuration( p_md->p_input_item ));
619 /**************************************************************************
620 * Parse the media.
621 **************************************************************************/
622 void
623 libvlc_media_parse(libvlc_media_t *media)
625 preparse_if_needed(media);
627 vlc_mutex_lock(&media->parsed_lock);
628 while (!media->is_parsed)
629 vlc_cond_wait(&media->parsed_cond, &media->parsed_lock);
630 vlc_mutex_unlock(&media->parsed_lock);
633 /**************************************************************************
634 * Parse the media.
635 **************************************************************************/
636 void
637 libvlc_media_parse_async(libvlc_media_t *media)
639 preparse_if_needed(media);
642 /**************************************************************************
643 * Get parsed status for media object.
644 **************************************************************************/
646 libvlc_media_is_parsed( libvlc_media_t * p_md )
648 assert( p_md );
650 if( !p_md->p_input_item )
651 return false;
653 return input_item_IsPreparsed( p_md->p_input_item );
656 /**************************************************************************
657 * Sets media descriptor's user_data. user_data is specialized data
658 * accessed by the host application, VLC.framework uses it as a pointer to
659 * an native object that references a libvlc_media_t pointer
660 **************************************************************************/
661 void
662 libvlc_media_set_user_data( libvlc_media_t * p_md, void * p_new_user_data )
664 assert( p_md );
665 p_md->p_user_data = p_new_user_data;
668 /**************************************************************************
669 * Get media descriptor's user_data. user_data is specialized data
670 * accessed by the host application, VLC.framework uses it as a pointer to
671 * an native object that references a libvlc_media_t pointer
672 **************************************************************************/
673 void *
674 libvlc_media_get_user_data( libvlc_media_t * p_md )
676 assert( p_md );
677 return p_md->p_user_data;
680 /**************************************************************************
681 * Get media descriptor's elementary streams description
682 **************************************************************************/
684 libvlc_media_get_tracks_info( libvlc_media_t *p_md, libvlc_media_track_info_t ** pp_es )
686 assert( p_md );
688 input_item_t *p_input_item = p_md->p_input_item;
689 vlc_mutex_lock( &p_input_item->lock );
691 const int i_es = p_input_item->i_es;
692 *pp_es = (i_es > 0) ? malloc( i_es * sizeof(libvlc_media_track_info_t) ) : NULL;
694 if( !pp_es ) /* no ES, or OOM */
696 vlc_mutex_unlock( &p_input_item->lock );
697 return 0;
700 /* Fill array */
701 for( int i = 0; i < i_es; i++ )
703 libvlc_media_track_info_t *p_mes = *pp_es+i;
704 const es_format_t *p_es = p_input_item->es[i];
706 p_mes->i_codec = p_es->i_codec;
707 p_mes->i_id = p_es->i_id;
709 p_mes->i_profile = p_es->i_profile;
710 p_mes->i_level = p_es->i_level;
712 switch(p_es->i_cat)
714 case UNKNOWN_ES:
715 default:
716 p_mes->i_type = libvlc_track_unknown;
717 break;
718 case VIDEO_ES:
719 p_mes->i_type = libvlc_track_video;
720 p_mes->u.video.i_height = p_es->video.i_height;
721 p_mes->u.video.i_width = p_es->video.i_width;
722 break;
723 case AUDIO_ES:
724 p_mes->i_type = libvlc_track_audio;
725 p_mes->u.audio.i_channels = p_es->audio.i_channels;
726 p_mes->u.audio.i_rate = p_es->audio.i_rate;
727 break;
728 case SPU_ES:
729 p_mes->i_type = libvlc_track_text;
730 break;
734 vlc_mutex_unlock( &p_input_item->lock );
735 return i_es;