libvlc: Remove all references to tag and dynamic media list.
[vlc.git] / src / control / media_descriptor.c
1 /*****************************************************************************
2  * media_descriptor.c: Libvlc API media descripor management
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Pierre d'Herbemont <pdherbemont@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 #include "libvlc_internal.h"
25
26 #include <vlc/libvlc.h>
27 #include <vlc_input.h>
28 #include <vlc_meta.h>
29
30 /* For the preparser */
31 #include <vlc_playlist.h>
32
33 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
34 {
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
52 };
53
54 static const libvlc_meta_t vlc_to_libvlc_meta[] =
55 {
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
73 };
74
75 /**************************************************************************
76  * input_item_subitem_added (Private) (vlc event Callback)
77  **************************************************************************/
78 static void input_item_subitem_added( const vlc_event_t *p_event,
79                                        void * user_data )
80 {
81     libvlc_media_descriptor_t * p_md = user_data;
82     libvlc_media_descriptor_t * p_md_child;
83     libvlc_event_t event;
84
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 );
88
89     /* Add this to our media list */
90     if( !p_md->p_subitems )
91     {
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 );
94     }
95     if( p_md->p_subitems )
96     {
97         libvlc_media_list_add_media_descriptor( p_md->p_subitems, p_md_child, NULL );
98     }
99
100     /* Construct the event */
101     event.type = libvlc_MediaDescriptorSubItemAdded;
102     event.u.media_descriptor_subitem_added.new_child = p_md_child;
103
104     /* Send the event */
105     libvlc_event_send( p_md->p_event_manager, &event );
106     libvlc_media_descriptor_release( p_md_child );
107 }
108
109 /**************************************************************************
110  * input_item_meta_changed (Private) (vlc event Callback)
111  **************************************************************************/
112 static void input_item_meta_changed( const vlc_event_t *p_event,
113                                      void * user_data )
114 {
115     libvlc_media_descriptor_t * p_md = user_data;
116     libvlc_event_t event;
117
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];
122
123     /* Send the event */
124     libvlc_event_send( p_md->p_event_manager, &event );
125 }
126
127 /**************************************************************************
128  * input_item_duration_changed (Private) (vlc event Callback)
129  **************************************************************************/
130 static void input_item_duration_changed( const vlc_event_t *p_event,
131                                          void * user_data )
132 {
133     libvlc_media_descriptor_t * p_md = user_data;
134     libvlc_event_t event;
135
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;
140
141     /* Send the event */
142     libvlc_event_send( p_md->p_event_manager, &event );
143 }
144
145 /**************************************************************************
146  * input_item_preparsed_changed (Private) (vlc event Callback)
147  **************************************************************************/
148 static void input_item_preparsed_changed( const vlc_event_t *p_event,
149                                           void * user_data )
150 {
151     libvlc_media_descriptor_t * p_md = user_data;
152     libvlc_event_t event;
153
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;
158
159     /* Send the event */
160     libvlc_event_send( p_md->p_event_manager, &event );
161 }
162
163 /**************************************************************************
164  * Install event handler (Private)
165  **************************************************************************/
166 static void install_input_item_observer( libvlc_media_descriptor_t *p_md )
167 {
168     vlc_event_attach( &p_md->p_input_item->event_manager,
169                       vlc_InputItemSubItemAdded,
170                       input_item_subitem_added,
171                       p_md );
172     vlc_event_attach( &p_md->p_input_item->event_manager,
173                       vlc_InputItemMetaChanged,
174                       input_item_meta_changed,
175                       p_md );
176     vlc_event_attach( &p_md->p_input_item->event_manager,
177                       vlc_InputItemDurationChanged,
178                       input_item_duration_changed,
179                       p_md );
180     vlc_event_attach( &p_md->p_input_item->event_manager,
181                       vlc_InputItemPreparsedChanged,
182                       input_item_preparsed_changed,
183                       p_md );
184 }
185
186 /**************************************************************************
187  * Uninstall event handler (Private)
188  **************************************************************************/
189 static void uninstall_input_item_observer( libvlc_media_descriptor_t *p_md )
190 {
191     vlc_event_detach( &p_md->p_input_item->event_manager,
192                       vlc_InputItemSubItemAdded,
193                       input_item_subitem_added,
194                       p_md );
195     vlc_event_detach( &p_md->p_input_item->event_manager,
196                       vlc_InputItemMetaChanged,
197                       input_item_meta_changed,
198                       p_md );
199     vlc_event_detach( &p_md->p_input_item->event_manager,
200                       vlc_InputItemDurationChanged,
201                       input_item_duration_changed,
202                       p_md );
203     vlc_event_detach( &p_md->p_input_item->event_manager,
204                       vlc_InputItemPreparsedChanged,
205                       input_item_preparsed_changed,
206                       p_md );
207 }
208
209 /**************************************************************************
210  * Preparse if not already done (Private)
211  **************************************************************************/
212 static void preparse_if_needed( libvlc_media_descriptor_t *p_md )
213 {
214     /* XXX: need some locking here */
215     if (!p_md->b_preparsed)
216     {
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;
221     }
222 }
223
224 /**************************************************************************
225  * Create a new media descriptor object from an input_item
226  * (libvlc internal)
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 )
233 {
234     libvlc_media_descriptor_t * p_md;
235
236     if (!p_input_item)
237     {
238         libvlc_exception_raise( p_e, "No input item given" );
239         return NULL;
240     }
241
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;
248
249     p_md->state = libvlc_NothingSpecial;
250
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;
254
255     p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance, p_e );
256     libvlc_event_manager_register_event_type( p_md->p_event_manager,
257         libvlc_MediaDescriptorMetaChanged, p_e );
258     libvlc_event_manager_register_event_type( p_md->p_event_manager,
259         libvlc_MediaDescriptorSubItemAdded, p_e );
260     libvlc_event_manager_register_event_type( p_md->p_event_manager,
261         libvlc_MediaDescriptorFreed, p_e );
262     libvlc_event_manager_register_event_type( p_md->p_event_manager,
263         libvlc_MediaDescriptorDurationChanged, p_e );
264     libvlc_event_manager_register_event_type( p_md->p_event_manager,
265         libvlc_MediaDescriptorStateChanged, p_e );
266
267     vlc_gc_incref( p_md->p_input_item );
268
269     install_input_item_observer( p_md );
270
271     return p_md;
272 }
273
274 /**************************************************************************
275  * Create a new media descriptor object
276  **************************************************************************/
277 libvlc_media_descriptor_t * libvlc_media_descriptor_new(
278                                    libvlc_instance_t *p_instance,
279                                    const char * psz_mrl,
280                                    libvlc_exception_t *p_e )
281 {
282     input_item_t * p_input_item;
283     libvlc_media_descriptor_t * p_md;
284
285     p_input_item = input_ItemNew( p_instance->p_libvlc_int, psz_mrl, NULL );
286
287     if (!p_input_item)
288     {
289         libvlc_exception_raise( p_e, "Can't create md's input_item" );
290         return NULL;
291     }
292
293     p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
294                 p_input_item, p_e );
295
296     /* The p_input_item is retained in libvlc_media_descriptor_new_from_input_item */
297     vlc_gc_decref( p_input_item );
298     
299     return p_md;
300 }
301
302 /**************************************************************************
303  * Create a new media descriptor object
304  **************************************************************************/
305 libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
306                                    libvlc_instance_t *p_instance,
307                                    const char * psz_name,
308                                    libvlc_exception_t *p_e )
309 {
310     input_item_t * p_input_item;
311     libvlc_media_descriptor_t * p_md;
312
313     p_input_item = input_ItemNew( p_instance->p_libvlc_int, "vlc://nop", psz_name );
314
315     if (!p_input_item)
316     {
317         libvlc_exception_raise( p_e, "Can't create md's input_item" );
318         return NULL;
319     }
320
321     p_md = libvlc_media_descriptor_new_from_input_item( p_instance,
322                 p_input_item, p_e );
323
324     p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance, NULL );
325
326     return p_md;
327 }
328
329 /**************************************************************************
330  * Add an option to the media descriptor,
331  * that will be used to determine how the media_instance will read the
332  * media_descriptor. This allow to use VLC advanced reading/streaming
333  * options in a per-media basis
334  *
335  * The options are detailled in vlc --long-help, for instance "--sout-all"
336  **************************************************************************/
337 void libvlc_media_descriptor_add_option(
338                                    libvlc_media_descriptor_t * p_md,
339                                    const char * ppsz_option,
340                                    libvlc_exception_t *p_e )
341 {
342     (void)p_e;
343     input_ItemAddOpt( p_md->p_input_item, ppsz_option,
344                       VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
345 }
346
347 /**************************************************************************
348  * Delete a media descriptor object
349  **************************************************************************/
350 void libvlc_media_descriptor_release( libvlc_media_descriptor_t *p_md )
351 {
352     int i;
353     if (!p_md)
354         return;
355
356     p_md->i_refcount--;
357
358     if( p_md->i_refcount > 0 )
359         return;
360
361     if( p_md->p_subitems )
362         libvlc_media_list_release( p_md->p_subitems );
363
364     uninstall_input_item_observer( p_md );
365     vlc_gc_decref( p_md->p_input_item );
366
367     /* Construct the event */
368     libvlc_event_t event;
369     event.type = libvlc_MediaDescriptorFreed;
370     event.u.media_descriptor_freed.md = p_md;
371
372     /* Send the event */
373     libvlc_event_send( p_md->p_event_manager, &event );
374
375     libvlc_event_manager_release( p_md->p_event_manager );
376
377     free( p_md );
378 }
379
380 /**************************************************************************
381  * Retain a media descriptor object
382  **************************************************************************/
383 void libvlc_media_descriptor_retain( libvlc_media_descriptor_t *p_md )
384 {
385     if (!p_md)
386         return;
387
388     p_md->i_refcount++;
389 }
390
391 /**************************************************************************
392  * Duplicate a media descriptor object
393  **************************************************************************/
394 libvlc_media_descriptor_t *
395 libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t *p_md_orig )
396 {
397     return libvlc_media_descriptor_new_from_input_item(
398         p_md_orig->p_libvlc_instance, p_md_orig->p_input_item, NULL );
399 }
400
401 /**************************************************************************
402  * Retain a media descriptor object
403  **************************************************************************/
404 char *
405 libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
406                                  libvlc_exception_t * p_e )
407 {
408     (void)p_e;
409     return input_item_GetURI( p_md->p_input_item );
410 }
411
412 /**************************************************************************
413  * Getter for meta information
414  **************************************************************************/
415
416 char * libvlc_media_descriptor_get_meta( libvlc_media_descriptor_t *p_md,
417                                          libvlc_meta_t e_meta,
418                                          libvlc_exception_t *p_e )
419 {
420     VLC_UNUSED(p_e);
421
422     char * psz_meta;
423
424     /* XXX: locking */
425
426     preparse_if_needed( p_md );
427
428     psz_meta = input_item_GetMeta( p_md->p_input_item,
429                                    libvlc_to_vlc_meta[e_meta] );
430     
431     if( e_meta == libvlc_meta_ArtworkURL && !psz_meta )
432     {
433         playlist_AskForArtEnqueue(
434                 p_md->p_libvlc_instance->p_libvlc_int->p_playlist,
435                 p_md->p_input_item );
436     }
437
438     /* Should be integrated in core */
439     if( !psz_meta && e_meta == libvlc_meta_Title && p_md->p_input_item->psz_name )
440     {
441         free( psz_meta );
442         return strdup( p_md->p_input_item->psz_name );
443     }
444
445     return psz_meta;
446 }
447
448 /**************************************************************************
449  * Getter for state information
450  * Can be error, playing, buffering, NothingSpecial.
451  **************************************************************************/
452
453 libvlc_state_t
454 libvlc_media_descriptor_get_state( libvlc_media_descriptor_t *p_md,
455                                    libvlc_exception_t *p_e )
456 {
457     (void)p_e;
458     return p_md->state;
459 }
460
461 /**************************************************************************
462  * Setter for state information (LibVLC Internal)
463  **************************************************************************/
464
465 void
466 libvlc_media_descriptor_set_state( libvlc_media_descriptor_t *p_md,
467                                    libvlc_state_t state,
468                                    libvlc_exception_t *p_e )
469 {
470     (void)p_e;
471     libvlc_event_t event;
472
473     p_md->state = state;
474
475     /* Construct the event */
476     event.type = libvlc_MediaDescriptorStateChanged;
477     event.u.media_descriptor_state_changed.new_state = state;
478
479     /* Send the event */
480     libvlc_event_send( p_md->p_event_manager, &event );
481 }
482
483 /**************************************************************************
484  * subitems
485  **************************************************************************/
486 libvlc_media_list_t *
487 libvlc_media_descriptor_subitems( libvlc_media_descriptor_t * p_md,
488                                   libvlc_exception_t * p_e )
489 {
490     VLC_UNUSED(p_e);
491
492     if( p_md->p_subitems )
493         libvlc_media_list_retain( p_md->p_subitems );
494     return p_md->p_subitems;
495 }
496
497 /**************************************************************************
498  * event_manager
499  **************************************************************************/
500 libvlc_event_manager_t *
501 libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
502                                        libvlc_exception_t * p_e )
503 {
504     VLC_UNUSED(p_e);
505
506     return p_md->p_event_manager;
507 }
508
509 /**************************************************************************
510  * Get duration of media_descriptor object.
511  **************************************************************************/
512 vlc_int64_t
513 libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
514                                       libvlc_exception_t * p_e )
515 {
516     VLC_UNUSED(p_e);
517
518     if( p_md && p_md->p_input_item)
519     {
520         return input_item_GetDuration( p_md->p_input_item );
521     }
522     else
523     {
524         return -1;
525     }
526 }
527
528 /**************************************************************************
529  * Get preparsed status for media_descriptor object.
530  **************************************************************************/
531 int
532 libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
533                                        libvlc_exception_t * p_e )
534 {
535     VLC_UNUSED(p_e);
536
537     if( p_md && p_md->p_input_item)
538     {
539         return input_item_IsPreparsed( p_md->p_input_item );
540     }
541     else
542     {
543         return VLC_FALSE;
544     }
545 }
546
547 /**************************************************************************
548  * Sets media descriptor's user_data. user_data is specialized data 
549  * accessed by the host application, VLC.framework uses it as a pointer to 
550  * an native object that references a libvlc_media_descriptor_t pointer
551  **************************************************************************/
552 void 
553 libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
554                                        void * p_new_user_data,
555                                        libvlc_exception_t * p_e )
556 {
557     VLC_UNUSED(p_e);
558
559     if( p_md )
560     {
561         p_md->p_user_data = p_new_user_data;
562     }
563 }
564
565 /**************************************************************************
566  * Get media descriptor's user_data. user_data is specialized data 
567  * accessed by the host application, VLC.framework uses it as a pointer to 
568  * an native object that references a libvlc_media_descriptor_t pointer
569  **************************************************************************/
570 void *
571 libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
572                                        libvlc_exception_t * p_e )
573 {
574     VLC_UNUSED(p_e);
575
576     if( p_md )
577     {
578         return p_md->p_user_data;
579     }
580     else
581     {
582         return NULL;
583     }
584 }
585