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 *****************************************************************************/
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_t * p_md = user_data;
82 libvlc_media_t * p_md_child;
85 p_md_child = libvlc_media_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( p_md->p_subitems, p_md, NULL );
95 if( p_md->p_subitems )
97 libvlc_media_list_add_media( p_md->p_subitems, p_md_child, NULL );
100 /* Construct the event */
101 event.type = libvlc_MediaSubItemAdded;
102 event.u.media_subitem_added.new_child = p_md_child;
105 libvlc_event_send( p_md->p_event_manager, &event );
106 libvlc_media_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_t * p_md = user_data;
116 libvlc_event_t event;
118 /* Construct the event */
119 event.type = libvlc_MediaMetaChanged;
120 event.u.media_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_t * p_md = user_data;
134 libvlc_event_t event;
136 /* Construct the event */
137 event.type = libvlc_MediaDurationChanged;
138 event.u.media_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_t * p_md = user_data;
152 libvlc_event_t event;
154 /* Construct the event */
155 event.type = libvlc_MediaPreparsedChanged;
156 event.u.media_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_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_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_t *p_md )
214 /* XXX: need some locking here */
215 if (!p_md->b_preparsed)
217 playlist_PreparseEnqueue(
218 libvlc_priv (p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
219 p_md->p_input_item, pl_Unlocked );
220 p_md->b_preparsed = true;
224 /**************************************************************************
225 * Create a new media descriptor object from an input_item
227 * That's the generic constructor
228 **************************************************************************/
229 libvlc_media_t * libvlc_media_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_t * p_md;
238 libvlc_exception_raise( p_e, "No input item given" );
242 p_md = malloc( sizeof(libvlc_media_t) );
245 libvlc_exception_raise( p_e, "Not enough memory" );
249 p_md->p_libvlc_instance = p_instance;
250 p_md->p_input_item = p_input_item;
251 p_md->b_preparsed = false;
252 p_md->i_refcount = 1;
253 p_md->p_user_data = NULL;
255 p_md->state = libvlc_NothingSpecial;
257 /* A media descriptor can be a playlist. When you open a playlist
258 * It can give a bunch of item to read. */
259 p_md->p_subitems = NULL;
261 p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance, p_e );
262 libvlc_event_manager_register_event_type( p_md->p_event_manager,
263 libvlc_MediaMetaChanged, p_e );
264 libvlc_event_manager_register_event_type( p_md->p_event_manager,
265 libvlc_MediaSubItemAdded, p_e );
266 libvlc_event_manager_register_event_type( p_md->p_event_manager,
267 libvlc_MediaFreed, p_e );
268 libvlc_event_manager_register_event_type( p_md->p_event_manager,
269 libvlc_MediaDurationChanged, p_e );
270 libvlc_event_manager_register_event_type( p_md->p_event_manager,
271 libvlc_MediaStateChanged, p_e );
273 vlc_gc_incref( p_md->p_input_item );
275 install_input_item_observer( p_md );
280 /**************************************************************************
281 * Create a new media descriptor object
282 **************************************************************************/
283 libvlc_media_t * libvlc_media_new(
284 libvlc_instance_t *p_instance,
285 const char * psz_mrl,
286 libvlc_exception_t *p_e )
288 input_item_t * p_input_item;
289 libvlc_media_t * p_md;
291 p_input_item = input_item_New( p_instance->p_libvlc_int, psz_mrl, NULL );
295 libvlc_exception_raise( p_e, "Can't create md's input_item" );
299 p_md = libvlc_media_new_from_input_item( p_instance,
302 /* The p_input_item is retained in libvlc_media_new_from_input_item */
303 vlc_gc_decref( p_input_item );
308 /**************************************************************************
309 * Create a new media descriptor object
310 **************************************************************************/
311 libvlc_media_t * libvlc_media_new_as_node(
312 libvlc_instance_t *p_instance,
313 const char * psz_name,
314 libvlc_exception_t *p_e )
316 input_item_t * p_input_item;
317 libvlc_media_t * p_md;
319 p_input_item = input_item_New( p_instance->p_libvlc_int, "vlc://nop", psz_name );
323 libvlc_exception_raise( p_e, "Can't create md's input_item" );
327 p_md = libvlc_media_new_from_input_item( p_instance,
330 p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
335 /**************************************************************************
336 * Add an option to the media descriptor,
337 * that will be used to determine how the media_player will read the
338 * media. This allow to use VLC advanced reading/streaming
339 * options in a per-media basis
341 * The options are detailled in vlc --long-help, for instance "--sout-all"
342 **************************************************************************/
343 void libvlc_media_add_option(
344 libvlc_media_t * p_md,
345 const char * ppsz_option,
346 libvlc_exception_t *p_e )
349 input_item_AddOption( p_md->p_input_item, ppsz_option,
350 VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
353 /**************************************************************************
354 * Same as libvlc_media_add_option but with untrusted source.
355 **************************************************************************/
356 void libvlc_media_add_option_untrusted(
357 libvlc_media_t * p_md,
358 const char * ppsz_option,
359 libvlc_exception_t *p_e )
362 input_item_AddOption( p_md->p_input_item, ppsz_option,
363 VLC_INPUT_OPTION_UNIQUE );
367 /**************************************************************************
368 * Delete a media descriptor object
369 **************************************************************************/
370 void libvlc_media_release( libvlc_media_t *p_md )
377 if( p_md->i_refcount > 0 )
380 if( p_md->p_subitems )
381 libvlc_media_list_release( p_md->p_subitems );
383 uninstall_input_item_observer( p_md );
384 vlc_gc_decref( p_md->p_input_item );
386 /* Construct the event */
387 libvlc_event_t event;
388 event.type = libvlc_MediaFreed;
389 event.u.media_freed.md = p_md;
392 libvlc_event_send( p_md->p_event_manager, &event );
394 libvlc_event_manager_release( p_md->p_event_manager );
399 /**************************************************************************
400 * Retain a media descriptor object
401 **************************************************************************/
402 void libvlc_media_retain( libvlc_media_t *p_md )
410 /**************************************************************************
411 * Duplicate a media descriptor object
412 **************************************************************************/
414 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
416 return libvlc_media_new_from_input_item(
417 p_md_orig->p_libvlc_instance, p_md_orig->p_input_item, NULL );
420 /**************************************************************************
421 * Get mrl from a media descriptor object
422 **************************************************************************/
424 libvlc_media_get_mrl( libvlc_media_t * p_md,
425 libvlc_exception_t * p_e )
428 return input_item_GetURI( p_md->p_input_item );
431 /**************************************************************************
432 * Getter for meta information
433 **************************************************************************/
435 char * libvlc_media_get_meta( libvlc_media_t *p_md,
436 libvlc_meta_t e_meta,
437 libvlc_exception_t *p_e )
444 preparse_if_needed( p_md );
446 psz_meta = input_item_GetMeta( p_md->p_input_item,
447 libvlc_to_vlc_meta[e_meta] );
449 if( e_meta == libvlc_meta_ArtworkURL && !psz_meta )
451 playlist_AskForArtEnqueue(
452 libvlc_priv(p_md->p_libvlc_instance->p_libvlc_int)->p_playlist,
453 p_md->p_input_item, pl_Unlocked );
456 /* Should be integrated in core */
457 if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
460 return strdup( p_md->p_input_item->psz_name );
466 /**************************************************************************
467 * Getter for state information
468 * Can be error, playing, buffering, NothingSpecial.
469 **************************************************************************/
472 libvlc_media_get_state( libvlc_media_t *p_md,
473 libvlc_exception_t *p_e )
479 /**************************************************************************
480 * Setter for state information (LibVLC Internal)
481 **************************************************************************/
484 libvlc_media_set_state( libvlc_media_t *p_md,
485 libvlc_state_t state,
486 libvlc_exception_t *p_e )
488 libvlc_event_t event;
493 /* Construct the event */
494 event.type = libvlc_MediaStateChanged;
495 event.u.media_state_changed.new_state = state;
498 libvlc_event_send( p_md->p_event_manager, &event );
501 /**************************************************************************
503 **************************************************************************/
504 libvlc_media_list_t *
505 libvlc_media_subitems( libvlc_media_t * p_md,
506 libvlc_exception_t * p_e )
510 if( p_md->p_subitems )
511 libvlc_media_list_retain( p_md->p_subitems );
512 return p_md->p_subitems;
515 /**************************************************************************
517 **************************************************************************/
518 libvlc_event_manager_t *
519 libvlc_media_event_manager( libvlc_media_t * p_md,
520 libvlc_exception_t * p_e )
524 return p_md->p_event_manager;
527 /**************************************************************************
528 * Get duration of media object.
529 **************************************************************************/
531 libvlc_media_get_duration( libvlc_media_t * p_md,
532 libvlc_exception_t * p_e )
536 if( !p_md || !p_md->p_input_item)
538 libvlc_exception_raise( p_e, "No input item" );
542 return input_item_GetDuration( p_md->p_input_item );
545 /**************************************************************************
546 * Get preparsed status for media object.
547 **************************************************************************/
549 libvlc_media_is_preparsed( libvlc_media_t * p_md,
550 libvlc_exception_t * p_e )
554 if( !p_md || !p_md->p_input_item)
556 libvlc_exception_raise( p_e, "No input item" );
560 return input_item_IsPreparsed( p_md->p_input_item );
563 /**************************************************************************
564 * Sets media descriptor's user_data. user_data is specialized data
565 * accessed by the host application, VLC.framework uses it as a pointer to
566 * an native object that references a libvlc_media_t pointer
567 **************************************************************************/
569 libvlc_media_set_user_data( libvlc_media_t * p_md,
570 void * p_new_user_data,
571 libvlc_exception_t * p_e )
577 p_md->p_user_data = p_new_user_data;
581 /**************************************************************************
582 * Get media descriptor's user_data. user_data is specialized data
583 * accessed by the host application, VLC.framework uses it as a pointer to
584 * an native object that references a libvlc_media_t pointer
585 **************************************************************************/
587 libvlc_media_get_user_data( libvlc_media_t * p_md,
588 libvlc_exception_t * p_e )
594 return p_md->p_user_data;