Qt: do not show open options in both normal and advanced UI
[vlc.git] / lib / media.c
blob03f49df5a06e28fd04675815d3091ecb3426daa2
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 "../src/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 * Create a new media descriptor object from an input_item
231 * (libvlc internal)
232 * That's the generic constructor
233 **************************************************************************/
234 libvlc_media_t * libvlc_media_new_from_input_item(
235 libvlc_instance_t *p_instance,
236 input_item_t *p_input_item )
238 libvlc_media_t * p_md;
240 if (!p_input_item)
242 libvlc_printerr( "No input item given" );
243 return NULL;
246 p_md = calloc( 1, sizeof(libvlc_media_t) );
247 if( !p_md )
249 libvlc_printerr( "Not enough memory" );
250 return NULL;
253 p_md->p_libvlc_instance = p_instance;
254 p_md->p_input_item = p_input_item;
255 p_md->i_refcount = 1;
257 vlc_cond_init(&p_md->parsed_cond);
258 vlc_mutex_init(&p_md->parsed_lock);
260 p_md->state = libvlc_NothingSpecial;
262 /* A media descriptor can be a playlist. When you open a playlist
263 * It can give a bunch of item to read. */
264 p_md->p_subitems = NULL;
266 p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance );
267 if( unlikely(p_md->p_event_manager == NULL) )
269 free(p_md);
270 return NULL;
273 libvlc_event_manager_t *em = p_md->p_event_manager;
274 libvlc_event_manager_register_event_type(em, libvlc_MediaMetaChanged);
275 libvlc_event_manager_register_event_type(em, libvlc_MediaSubItemAdded);
276 libvlc_event_manager_register_event_type(em, libvlc_MediaFreed);
277 libvlc_event_manager_register_event_type(em, libvlc_MediaDurationChanged);
278 libvlc_event_manager_register_event_type(em, libvlc_MediaStateChanged);
279 libvlc_event_manager_register_event_type(em, libvlc_MediaParsedChanged);
281 vlc_gc_incref( p_md->p_input_item );
283 install_input_item_observer( p_md );
285 return p_md;
288 /**************************************************************************
289 * Create a new media descriptor object
290 **************************************************************************/
291 libvlc_media_t *libvlc_media_new_location( libvlc_instance_t *p_instance,
292 const char * psz_mrl )
294 input_item_t * p_input_item;
295 libvlc_media_t * p_md;
297 p_input_item = input_item_New( psz_mrl, NULL );
299 if (!p_input_item)
301 libvlc_printerr( "Not enough memory" );
302 return NULL;
305 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
307 /* The p_input_item is retained in libvlc_media_new_from_input_item */
308 vlc_gc_decref( p_input_item );
310 return p_md;
313 libvlc_media_t *libvlc_media_new_path( libvlc_instance_t *p_instance,
314 const char *path )
316 char *mrl = make_URI( path, "file" );
317 if( unlikely(mrl == NULL) )
319 libvlc_printerr( "Not enough memory" );
320 return NULL;
323 libvlc_media_t *m = libvlc_media_new_location( p_instance, mrl );
324 free( mrl );
325 return m;
328 libvlc_media_t *libvlc_media_new_fd( libvlc_instance_t *p_instance, int fd )
330 char mrl[16];
331 snprintf( mrl, sizeof(mrl), "fd://%d", fd );
333 return libvlc_media_new_location( p_instance, mrl );
336 /**************************************************************************
337 * Create a new media descriptor object
338 **************************************************************************/
339 libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance,
340 const char * psz_name )
342 input_item_t * p_input_item;
343 libvlc_media_t * p_md;
345 p_input_item = input_item_New( "vlc://nop", psz_name );
347 if (!p_input_item)
349 libvlc_printerr( "Not enough memory" );
350 return NULL;
353 p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
355 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
357 return p_md;
360 /**************************************************************************
361 * Add an option to the media descriptor,
362 * that will be used to determine how the media_player will read the
363 * media. This allow to use VLC advanced reading/streaming
364 * options in a per-media basis
366 * The options are detailled in vlc --long-help, for instance "--sout-all"
367 **************************************************************************/
368 void libvlc_media_add_option( libvlc_media_t * p_md,
369 const char * psz_option )
371 libvlc_media_add_option_flag( p_md, psz_option,
372 VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
375 /**************************************************************************
376 * Same as libvlc_media_add_option but with configurable flags.
377 **************************************************************************/
378 void libvlc_media_add_option_flag( libvlc_media_t * p_md,
379 const char * ppsz_option,
380 unsigned i_flags )
382 input_item_AddOption( p_md->p_input_item, ppsz_option, i_flags );
385 /**************************************************************************
386 * Delete a media descriptor object
387 **************************************************************************/
388 void libvlc_media_release( libvlc_media_t *p_md )
390 if (!p_md)
391 return;
393 p_md->i_refcount--;
395 if( p_md->i_refcount > 0 )
396 return;
398 if( p_md->p_subitems )
399 libvlc_media_list_release( p_md->p_subitems );
401 uninstall_input_item_observer( p_md );
402 vlc_gc_decref( p_md->p_input_item );
404 vlc_cond_destroy( &p_md->parsed_cond );
405 vlc_mutex_destroy( &p_md->parsed_lock );
407 /* Construct the event */
408 libvlc_event_t event;
409 event.type = libvlc_MediaFreed;
410 event.u.media_freed.md = p_md;
412 /* Send the event */
413 libvlc_event_send( p_md->p_event_manager, &event );
415 libvlc_event_manager_release( p_md->p_event_manager );
417 free( p_md );
420 /**************************************************************************
421 * Retain a media descriptor object
422 **************************************************************************/
423 void libvlc_media_retain( libvlc_media_t *p_md )
425 assert (p_md);
426 p_md->i_refcount++;
429 /**************************************************************************
430 * Duplicate a media descriptor object
431 **************************************************************************/
432 libvlc_media_t *
433 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
435 return libvlc_media_new_from_input_item(
436 p_md_orig->p_libvlc_instance, p_md_orig->p_input_item );
439 /**************************************************************************
440 * Get mrl from a media descriptor object
441 **************************************************************************/
442 char *
443 libvlc_media_get_mrl( libvlc_media_t * p_md )
445 assert( p_md );
446 return input_item_GetURI( p_md->p_input_item );
449 /**************************************************************************
450 * Getter for meta information
451 **************************************************************************/
453 char *libvlc_media_get_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta )
455 char *psz_meta = input_item_GetMeta( p_md->p_input_item,
456 libvlc_to_vlc_meta[e_meta] );
457 /* Should be integrated in core */
458 if( psz_meta == NULL && e_meta == libvlc_meta_Title
459 && p_md->p_input_item->psz_name != NULL )
460 psz_meta = strdup( p_md->p_input_item->psz_name );
462 return psz_meta;
465 /**************************************************************************
466 * Setter for meta information
467 **************************************************************************/
469 void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, const char *psz_value )
471 assert( p_md );
472 input_item_SetMeta( p_md->p_input_item, libvlc_to_vlc_meta[e_meta], psz_value );
475 int libvlc_media_save_meta( libvlc_media_t *p_md )
477 assert( p_md );
478 vlc_object_t *p_obj = VLC_OBJECT(libvlc_priv(
479 p_md->p_libvlc_instance->p_libvlc_int)->p_playlist);
480 return input_item_WriteMeta( p_obj, p_md->p_input_item ) == VLC_SUCCESS;
483 /**************************************************************************
484 * Getter for state information
485 * Can be error, playing, buffering, NothingSpecial.
486 **************************************************************************/
488 libvlc_state_t
489 libvlc_media_get_state( libvlc_media_t *p_md )
491 assert( p_md );
492 return p_md->state;
495 /**************************************************************************
496 * Setter for state information (LibVLC Internal)
497 **************************************************************************/
499 void
500 libvlc_media_set_state( libvlc_media_t *p_md,
501 libvlc_state_t state )
503 libvlc_event_t event;
505 p_md->state = state;
507 /* Construct the event */
508 event.type = libvlc_MediaStateChanged;
509 event.u.media_state_changed.new_state = state;
511 /* Send the event */
512 libvlc_event_send( p_md->p_event_manager, &event );
515 /**************************************************************************
516 * subitems
517 **************************************************************************/
518 libvlc_media_list_t *
519 libvlc_media_subitems( libvlc_media_t * p_md )
521 if( p_md->p_subitems )
522 libvlc_media_list_retain( p_md->p_subitems );
523 return p_md->p_subitems;
526 /**************************************************************************
527 * Getter for statistics information
528 **************************************************************************/
529 int libvlc_media_get_stats( libvlc_media_t *p_md,
530 libvlc_media_stats_t *p_stats )
532 if( !p_md->p_input_item )
533 return false;
535 input_stats_t *p_itm_stats = p_md->p_input_item->p_stats;
536 vlc_mutex_lock( &p_itm_stats->lock );
537 p_stats->i_read_bytes = p_itm_stats->i_read_bytes;
538 p_stats->f_input_bitrate = p_itm_stats->f_input_bitrate;
540 p_stats->i_demux_read_bytes = p_itm_stats->i_demux_read_bytes;
541 p_stats->f_demux_bitrate = p_itm_stats->f_demux_bitrate;
542 p_stats->i_demux_corrupted = p_itm_stats->i_demux_corrupted;
543 p_stats->i_demux_discontinuity = p_itm_stats->i_demux_discontinuity;
545 p_stats->i_decoded_video = p_itm_stats->i_decoded_video;
546 p_stats->i_decoded_audio = p_itm_stats->i_decoded_audio;
548 p_stats->i_displayed_pictures = p_itm_stats->i_displayed_pictures;
549 p_stats->i_lost_pictures = p_itm_stats->i_lost_pictures;
551 p_stats->i_played_abuffers = p_itm_stats->i_played_abuffers;
552 p_stats->i_lost_abuffers = p_itm_stats->i_lost_abuffers;
554 p_stats->i_sent_packets = p_itm_stats->i_sent_packets;
555 p_stats->i_sent_bytes = p_itm_stats->i_sent_bytes;
556 p_stats->f_send_bitrate = p_itm_stats->f_send_bitrate;
557 vlc_mutex_unlock( &p_itm_stats->lock );
558 return true;
561 /**************************************************************************
562 * event_manager
563 **************************************************************************/
564 libvlc_event_manager_t *
565 libvlc_media_event_manager( libvlc_media_t * p_md )
567 assert( p_md );
569 return p_md->p_event_manager;
572 /**************************************************************************
573 * Get duration of media object (in ms)
574 **************************************************************************/
575 int64_t
576 libvlc_media_get_duration( libvlc_media_t * p_md )
578 assert( p_md );
580 if( !p_md->p_input_item )
582 libvlc_printerr( "No input item" );
583 return -1;
586 if (!input_item_IsPreparsed( p_md->p_input_item ))
587 return -1;
589 return from_mtime(input_item_GetDuration( p_md->p_input_item ));
592 static int media_parse(libvlc_media_t *media)
594 /* TODO: fetcher and parser independent of playlist */
595 playlist_t *playlist =
596 libvlc_priv (media->p_libvlc_instance->p_libvlc_int)->p_playlist;
598 /* TODO: Fetch art on need basis. But how not to break compatibility? */
599 playlist_AskForArtEnqueue(playlist, media->p_input_item );
600 return playlist_PreparseEnqueue(playlist, media->p_input_item);
603 /**************************************************************************
604 * Parse the media and wait.
605 **************************************************************************/
606 void
607 libvlc_media_parse(libvlc_media_t *media)
609 vlc_mutex_lock(&media->parsed_lock);
610 if (!media->has_asked_preparse)
612 media->has_asked_preparse = true;
613 vlc_mutex_unlock(&media->parsed_lock);
615 if (media_parse(media))
616 /* Parse failed: do not wait! */
617 return;
618 vlc_mutex_lock(&media->parsed_lock);
621 while (!media->is_parsed)
622 vlc_cond_wait(&media->parsed_cond, &media->parsed_lock);
623 vlc_mutex_unlock(&media->parsed_lock);
626 /**************************************************************************
627 * Parse the media but do not wait.
628 **************************************************************************/
629 void
630 libvlc_media_parse_async(libvlc_media_t *media)
632 bool needed;
634 vlc_mutex_lock(&media->parsed_lock);
635 needed = !media->has_asked_preparse;
636 media->has_asked_preparse = true;
637 vlc_mutex_unlock(&media->parsed_lock);
639 if (needed)
640 media_parse(media);
643 /**************************************************************************
644 * Get parsed status for media object.
645 **************************************************************************/
647 libvlc_media_is_parsed(libvlc_media_t *media)
649 bool parsed;
651 vlc_mutex_lock(&media->parsed_lock);
652 parsed = media->is_parsed;
653 vlc_mutex_unlock(&media->parsed_lock);
654 return parsed;
657 /**************************************************************************
658 * Sets media descriptor's user_data. user_data is specialized data
659 * accessed by the host application, VLC.framework uses it as a pointer to
660 * an native object that references a libvlc_media_t pointer
661 **************************************************************************/
662 void
663 libvlc_media_set_user_data( libvlc_media_t * p_md, void * p_new_user_data )
665 assert( p_md );
666 p_md->p_user_data = p_new_user_data;
669 /**************************************************************************
670 * Get media descriptor's user_data. user_data is specialized data
671 * accessed by the host application, VLC.framework uses it as a pointer to
672 * an native object that references a libvlc_media_t pointer
673 **************************************************************************/
674 void *
675 libvlc_media_get_user_data( libvlc_media_t * p_md )
677 assert( p_md );
678 return p_md->p_user_data;
681 /**************************************************************************
682 * Get media descriptor's elementary streams description
683 **************************************************************************/
685 libvlc_media_get_tracks_info( libvlc_media_t *p_md, libvlc_media_track_info_t ** pp_es )
687 assert( p_md );
689 input_item_t *p_input_item = p_md->p_input_item;
690 vlc_mutex_lock( &p_input_item->lock );
692 const int i_es = p_input_item->i_es;
693 *pp_es = (i_es > 0) ? malloc( i_es * sizeof(libvlc_media_track_info_t) ) : NULL;
695 if( !*pp_es ) /* no ES, or OOM */
697 vlc_mutex_unlock( &p_input_item->lock );
698 return 0;
701 /* Fill array */
702 for( int i = 0; i < i_es; i++ )
704 libvlc_media_track_info_t *p_mes = *pp_es+i;
705 const es_format_t *p_es = p_input_item->es[i];
707 p_mes->i_codec = p_es->i_codec;
708 p_mes->i_id = p_es->i_id;
710 p_mes->i_profile = p_es->i_profile;
711 p_mes->i_level = p_es->i_level;
713 switch(p_es->i_cat)
715 case UNKNOWN_ES:
716 default:
717 p_mes->i_type = libvlc_track_unknown;
718 break;
719 case VIDEO_ES:
720 p_mes->i_type = libvlc_track_video;
721 p_mes->u.video.i_height = p_es->video.i_height;
722 p_mes->u.video.i_width = p_es->video.i_width;
723 break;
724 case AUDIO_ES:
725 p_mes->i_type = libvlc_track_audio;
726 p_mes->u.audio.i_channels = p_es->audio.i_channels;
727 p_mes->u.audio.i_rate = p_es->audio.i_rate;
728 break;
729 case SPU_ES:
730 p_mes->i_type = libvlc_track_text;
731 break;
735 vlc_mutex_unlock( &p_input_item->lock );
736 return i_es;