]> git.sesse.net Git - vlc/blob - lib/media.c
04314b02a3b255fc2f24dd1fc5b7a470229f7f09
[vlc] / lib / media.c
1 /*****************************************************************************
2  * media.c: Libvlc API media descripor management
3  *****************************************************************************
4  * Copyright (C) 2007 VLC authors and VideoLAN
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 it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <assert.h>
29
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>
34
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>
40
41 #include "../src/libvlc.h"
42
43 #include "libvlc_internal.h"
44 #include "media_internal.h"
45
46 static const vlc_meta_type_t libvlc_to_vlc_meta[] =
47 {
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
65 };
66
67 static const libvlc_meta_t vlc_to_libvlc_meta[] =
68 {
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
86 };
87
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 )
93 {
94     libvlc_media_t * p_md = user_data;
95     libvlc_media_t * p_md_child;
96     libvlc_event_t event;
97
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 );
101
102     /* Add this to our media list */
103     if( !p_md->p_subitems )
104     {
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 );
107     }
108     if( p_md->p_subitems )
109     {
110         libvlc_media_list_add_media( p_md->p_subitems, p_md_child );
111     }
112
113     /* Construct the event */
114     event.type = libvlc_MediaSubItemAdded;
115     event.u.media_subitem_added.new_child = p_md_child;
116
117     /* Send the event */
118     libvlc_event_send( p_md->p_event_manager, &event );
119     libvlc_media_release( p_md_child );
120 }
121
122 /**************************************************************************
123  * input_item_subitemtree_added (Private) (vlc event Callback)
124  **************************************************************************/
125 static void input_item_subitemtree_added( const vlc_event_t * p_event,
126                                           void * user_data )
127 {
128     VLC_UNUSED( p_event );
129     libvlc_media_t * p_md = user_data;
130     libvlc_event_t event;
131
132     /* Construct the event */
133     event.type = libvlc_MediaSubItemTreeAdded;
134     event.u.media_subitemtree_added.item = p_md;
135
136     /* Send the event */
137     libvlc_event_send( p_md->p_event_manager, &event );
138 }
139
140 /**************************************************************************
141  * input_item_meta_changed (Private) (vlc event Callback)
142  **************************************************************************/
143 static void input_item_meta_changed( const vlc_event_t *p_event,
144                                      void * user_data )
145 {
146     libvlc_media_t * p_md = user_data;
147     libvlc_event_t event;
148
149     /* Construct the event */
150     event.type = libvlc_MediaMetaChanged;
151     event.u.media_meta_changed.meta_type =
152         vlc_to_libvlc_meta[p_event->u.input_item_meta_changed.meta_type];
153
154     /* Send the event */
155     libvlc_event_send( p_md->p_event_manager, &event );
156 }
157
158 /**************************************************************************
159  * input_item_duration_changed (Private) (vlc event Callback)
160  **************************************************************************/
161 static void input_item_duration_changed( const vlc_event_t *p_event,
162                                          void * user_data )
163 {
164     libvlc_media_t * p_md = user_data;
165     libvlc_event_t event;
166
167     /* Construct the event */
168     event.type = libvlc_MediaDurationChanged;
169     event.u.media_duration_changed.new_duration =
170         from_mtime(p_event->u.input_item_duration_changed.new_duration);
171
172     /* Send the event */
173     libvlc_event_send( p_md->p_event_manager, &event );
174 }
175
176 /**************************************************************************
177  * input_item_preparsed_changed (Private) (vlc event Callback)
178  **************************************************************************/
179 static void input_item_preparsed_changed(const vlc_event_t *p_event,
180                                          void * user_data)
181 {
182     libvlc_media_t *media = user_data;
183     libvlc_event_t event;
184
185     /* Eventually notify libvlc_media_parse() */
186     vlc_mutex_lock(&media->parsed_lock);
187     media->is_parsed = true;
188     vlc_cond_broadcast(&media->parsed_cond);
189     vlc_mutex_unlock(&media->parsed_lock);
190
191
192     /* Construct the event */
193     event.type = libvlc_MediaParsedChanged;
194     event.u.media_parsed_changed.new_status =
195         p_event->u.input_item_preparsed_changed.new_status;
196
197     /* Send the event */
198     libvlc_event_send(media->p_event_manager, &event);
199 }
200
201 /**************************************************************************
202  * Install event handler (Private)
203  **************************************************************************/
204 static void install_input_item_observer( libvlc_media_t *p_md )
205 {
206     vlc_event_attach( &p_md->p_input_item->event_manager,
207                       vlc_InputItemSubItemAdded,
208                       input_item_subitem_added,
209                       p_md );
210     vlc_event_attach( &p_md->p_input_item->event_manager,
211                       vlc_InputItemMetaChanged,
212                       input_item_meta_changed,
213                       p_md );
214     vlc_event_attach( &p_md->p_input_item->event_manager,
215                       vlc_InputItemDurationChanged,
216                       input_item_duration_changed,
217                       p_md );
218     vlc_event_attach( &p_md->p_input_item->event_manager,
219                       vlc_InputItemPreparsedChanged,
220                       input_item_preparsed_changed,
221                       p_md );
222     vlc_event_attach( &p_md->p_input_item->event_manager,
223                       vlc_InputItemSubItemTreeAdded,
224                       input_item_subitemtree_added,
225                       p_md );
226 }
227
228 /**************************************************************************
229  * Uninstall event handler (Private)
230  **************************************************************************/
231 static void uninstall_input_item_observer( libvlc_media_t *p_md )
232 {
233     vlc_event_detach( &p_md->p_input_item->event_manager,
234                       vlc_InputItemSubItemAdded,
235                       input_item_subitem_added,
236                       p_md );
237     vlc_event_detach( &p_md->p_input_item->event_manager,
238                       vlc_InputItemMetaChanged,
239                       input_item_meta_changed,
240                       p_md );
241     vlc_event_detach( &p_md->p_input_item->event_manager,
242                       vlc_InputItemDurationChanged,
243                       input_item_duration_changed,
244                       p_md );
245     vlc_event_detach( &p_md->p_input_item->event_manager,
246                       vlc_InputItemPreparsedChanged,
247                       input_item_preparsed_changed,
248                       p_md );
249     vlc_event_detach( &p_md->p_input_item->event_manager,
250                       vlc_InputItemSubItemTreeAdded,
251                       input_item_subitemtree_added,
252                       p_md );
253 }
254
255 /**************************************************************************
256  * Create a new media descriptor object from an input_item
257  * (libvlc internal)
258  * That's the generic constructor
259  **************************************************************************/
260 libvlc_media_t * libvlc_media_new_from_input_item(
261                                    libvlc_instance_t *p_instance,
262                                    input_item_t *p_input_item )
263 {
264     libvlc_media_t * p_md;
265
266     if (!p_input_item)
267     {
268         libvlc_printerr( "No input item given" );
269         return NULL;
270     }
271
272     p_md = calloc( 1, sizeof(libvlc_media_t) );
273     if( !p_md )
274     {
275         libvlc_printerr( "Not enough memory" );
276         return NULL;
277     }
278
279     p_md->p_libvlc_instance = p_instance;
280     p_md->p_input_item      = p_input_item;
281     p_md->i_refcount        = 1;
282
283     vlc_cond_init(&p_md->parsed_cond);
284     vlc_mutex_init(&p_md->parsed_lock);
285
286     p_md->state = libvlc_NothingSpecial;
287
288     /* A media descriptor can be a playlist. When you open a playlist
289      * It can give a bunch of item to read. */
290     p_md->p_subitems        = NULL;
291
292     p_md->p_event_manager = libvlc_event_manager_new( p_md, p_instance );
293     if( unlikely(p_md->p_event_manager == NULL) )
294     {
295         free(p_md);
296         return NULL;
297     }
298
299     libvlc_event_manager_t *em = p_md->p_event_manager;
300     libvlc_event_manager_register_event_type(em, libvlc_MediaMetaChanged);
301     libvlc_event_manager_register_event_type(em, libvlc_MediaSubItemAdded);
302     libvlc_event_manager_register_event_type(em, libvlc_MediaFreed);
303     libvlc_event_manager_register_event_type(em, libvlc_MediaDurationChanged);
304     libvlc_event_manager_register_event_type(em, libvlc_MediaStateChanged);
305     libvlc_event_manager_register_event_type(em, libvlc_MediaParsedChanged);
306     libvlc_event_manager_register_event_type(em, libvlc_MediaSubItemTreeAdded);
307
308     vlc_gc_incref( p_md->p_input_item );
309
310     install_input_item_observer( p_md );
311
312     return p_md;
313 }
314
315 /**************************************************************************
316  * Create a new media descriptor object
317  **************************************************************************/
318 libvlc_media_t *libvlc_media_new_location( libvlc_instance_t *p_instance,
319                                            const char * psz_mrl )
320 {
321     input_item_t * p_input_item;
322     libvlc_media_t * p_md;
323
324     p_input_item = input_item_New( psz_mrl, NULL );
325
326     if (!p_input_item)
327     {
328         libvlc_printerr( "Not enough memory" );
329         return NULL;
330     }
331
332     p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
333
334     /* The p_input_item is retained in libvlc_media_new_from_input_item */
335     vlc_gc_decref( p_input_item );
336
337     return p_md;
338 }
339
340 libvlc_media_t *libvlc_media_new_path( libvlc_instance_t *p_instance,
341                                        const char *path )
342 {
343     char *mrl = vlc_path2uri( path, NULL );
344     if( unlikely(mrl == NULL) )
345     {
346         libvlc_printerr( "Not enough memory" );
347         return NULL;
348     }
349
350     libvlc_media_t *m = libvlc_media_new_location( p_instance, mrl );
351     free( mrl );
352     return m;
353 }
354
355 libvlc_media_t *libvlc_media_new_fd( libvlc_instance_t *p_instance, int fd )
356 {
357     char mrl[16];
358     snprintf( mrl, sizeof(mrl), "fd://%d", fd );
359
360     return libvlc_media_new_location( p_instance, mrl );
361 }
362
363 /**************************************************************************
364  * Create a new media descriptor object
365  **************************************************************************/
366 libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance,
367                                            const char * psz_name )
368 {
369     input_item_t * p_input_item;
370     libvlc_media_t * p_md;
371
372     p_input_item = input_item_New( "vlc://nop", psz_name );
373
374     if (!p_input_item)
375     {
376         libvlc_printerr( "Not enough memory" );
377         return NULL;
378     }
379
380     p_md = libvlc_media_new_from_input_item( p_instance, p_input_item );
381
382     p_md->p_subitems = libvlc_media_list_new( p_md->p_libvlc_instance );
383
384     return p_md;
385 }
386
387 /**************************************************************************
388  * Add an option to the media descriptor,
389  * that will be used to determine how the media_player will read the
390  * media. This allow to use VLC advanced reading/streaming
391  * options in a per-media basis
392  *
393  * The options are detailled in vlc --long-help, for instance "--sout-all"
394  **************************************************************************/
395 void libvlc_media_add_option( libvlc_media_t * p_md,
396                               const char * psz_option )
397 {
398     libvlc_media_add_option_flag( p_md, psz_option,
399                           VLC_INPUT_OPTION_UNIQUE|VLC_INPUT_OPTION_TRUSTED );
400 }
401
402 /**************************************************************************
403  * Same as libvlc_media_add_option but with configurable flags.
404  **************************************************************************/
405 void libvlc_media_add_option_flag( libvlc_media_t * p_md,
406                                    const char * ppsz_option,
407                                    unsigned i_flags )
408 {
409     input_item_AddOption( p_md->p_input_item, ppsz_option, i_flags );
410 }
411
412 /**************************************************************************
413  * Delete a media descriptor object
414  **************************************************************************/
415 void libvlc_media_release( libvlc_media_t *p_md )
416 {
417     if (!p_md)
418         return;
419
420     p_md->i_refcount--;
421
422     if( p_md->i_refcount > 0 )
423         return;
424
425     if( p_md->p_subitems )
426         libvlc_media_list_release( p_md->p_subitems );
427
428     uninstall_input_item_observer( p_md );
429     vlc_gc_decref( p_md->p_input_item );
430
431     vlc_cond_destroy( &p_md->parsed_cond );
432     vlc_mutex_destroy( &p_md->parsed_lock );
433
434     /* Construct the event */
435     libvlc_event_t event;
436     event.type = libvlc_MediaFreed;
437     event.u.media_freed.md = p_md;
438
439     /* Send the event */
440     libvlc_event_send( p_md->p_event_manager, &event );
441
442     libvlc_event_manager_release( p_md->p_event_manager );
443
444     free( p_md );
445 }
446
447 /**************************************************************************
448  * Retain a media descriptor object
449  **************************************************************************/
450 void libvlc_media_retain( libvlc_media_t *p_md )
451 {
452     assert (p_md);
453     p_md->i_refcount++;
454 }
455
456 /**************************************************************************
457  * Duplicate a media descriptor object
458  **************************************************************************/
459 libvlc_media_t *
460 libvlc_media_duplicate( libvlc_media_t *p_md_orig )
461 {
462     return libvlc_media_new_from_input_item(
463         p_md_orig->p_libvlc_instance, p_md_orig->p_input_item );
464 }
465
466 /**************************************************************************
467  * Get mrl from a media descriptor object
468  **************************************************************************/
469 char *
470 libvlc_media_get_mrl( libvlc_media_t * p_md )
471 {
472     assert( p_md );
473     return input_item_GetURI( p_md->p_input_item );
474 }
475
476 /**************************************************************************
477  * Getter for meta information
478  **************************************************************************/
479
480 char *libvlc_media_get_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta )
481 {
482     char *psz_meta = input_item_GetMeta( p_md->p_input_item,
483                                          libvlc_to_vlc_meta[e_meta] );
484     /* Should be integrated in core */
485     if( psz_meta == NULL && e_meta == libvlc_meta_Title
486      && p_md->p_input_item->psz_name != NULL )
487         psz_meta = strdup( p_md->p_input_item->psz_name );
488
489     return psz_meta;
490 }
491
492 /**************************************************************************
493  * Setter for meta information
494  **************************************************************************/
495
496 void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, const char *psz_value )
497 {
498     assert( p_md );
499     input_item_SetMeta( p_md->p_input_item, libvlc_to_vlc_meta[e_meta], psz_value );
500 }
501
502 int libvlc_media_save_meta( libvlc_media_t *p_md )
503 {
504     assert( p_md );
505     vlc_object_t *p_obj = VLC_OBJECT(p_md->p_libvlc_instance->p_libvlc_int);
506     return input_item_WriteMeta( p_obj, p_md->p_input_item ) == VLC_SUCCESS;
507 }
508
509 /**************************************************************************
510  * Getter for state information
511  * Can be error, playing, buffering, NothingSpecial.
512  **************************************************************************/
513
514 libvlc_state_t
515 libvlc_media_get_state( libvlc_media_t *p_md )
516 {
517     assert( p_md );
518     return p_md->state;
519 }
520
521 /**************************************************************************
522  * Setter for state information (LibVLC Internal)
523  **************************************************************************/
524
525 void
526 libvlc_media_set_state( libvlc_media_t *p_md,
527                                    libvlc_state_t state )
528 {
529     libvlc_event_t event;
530
531     p_md->state = state;
532
533     /* Construct the event */
534     event.type = libvlc_MediaStateChanged;
535     event.u.media_state_changed.new_state = state;
536
537     /* Send the event */
538     libvlc_event_send( p_md->p_event_manager, &event );
539 }
540
541 /**************************************************************************
542  * subitems
543  **************************************************************************/
544 libvlc_media_list_t *
545 libvlc_media_subitems( libvlc_media_t * p_md )
546 {
547     if( p_md->p_subitems )
548         libvlc_media_list_retain( p_md->p_subitems );
549     return p_md->p_subitems;
550 }
551
552 /**************************************************************************
553  * Getter for statistics information
554  **************************************************************************/
555 int libvlc_media_get_stats( libvlc_media_t *p_md,
556                             libvlc_media_stats_t *p_stats )
557 {
558     if( !p_md->p_input_item )
559         return false;
560
561     input_stats_t *p_itm_stats = p_md->p_input_item->p_stats;
562     vlc_mutex_lock( &p_itm_stats->lock );
563     p_stats->i_read_bytes = p_itm_stats->i_read_bytes;
564     p_stats->f_input_bitrate = p_itm_stats->f_input_bitrate;
565
566     p_stats->i_demux_read_bytes = p_itm_stats->i_demux_read_bytes;
567     p_stats->f_demux_bitrate = p_itm_stats->f_demux_bitrate;
568     p_stats->i_demux_corrupted = p_itm_stats->i_demux_corrupted;
569     p_stats->i_demux_discontinuity = p_itm_stats->i_demux_discontinuity;
570
571     p_stats->i_decoded_video = p_itm_stats->i_decoded_video;
572     p_stats->i_decoded_audio = p_itm_stats->i_decoded_audio;
573
574     p_stats->i_displayed_pictures = p_itm_stats->i_displayed_pictures;
575     p_stats->i_lost_pictures = p_itm_stats->i_lost_pictures;
576
577     p_stats->i_played_abuffers = p_itm_stats->i_played_abuffers;
578     p_stats->i_lost_abuffers = p_itm_stats->i_lost_abuffers;
579
580     p_stats->i_sent_packets = p_itm_stats->i_sent_packets;
581     p_stats->i_sent_bytes = p_itm_stats->i_sent_bytes;
582     p_stats->f_send_bitrate = p_itm_stats->f_send_bitrate;
583     vlc_mutex_unlock( &p_itm_stats->lock );
584     return true;
585 }
586
587 /**************************************************************************
588  * event_manager
589  **************************************************************************/
590 libvlc_event_manager_t *
591 libvlc_media_event_manager( libvlc_media_t * p_md )
592 {
593     assert( p_md );
594
595     return p_md->p_event_manager;
596 }
597
598 /**************************************************************************
599  * Get duration of media object (in ms)
600  **************************************************************************/
601 int64_t
602 libvlc_media_get_duration( libvlc_media_t * p_md )
603 {
604     assert( p_md );
605
606     if( !p_md->p_input_item )
607     {
608         libvlc_printerr( "No input item" );
609         return -1;
610     }
611
612     if (!input_item_IsPreparsed( p_md->p_input_item ))
613         return -1;
614
615     return from_mtime(input_item_GetDuration( p_md->p_input_item ));
616 }
617
618 static int media_parse(libvlc_media_t *media)
619 {
620     libvlc_int_t *libvlc = media->p_libvlc_instance->p_libvlc_int;
621     input_item_t *item = media->p_input_item;
622
623     /* TODO: Fetch art on need basis. But how not to break compatibility? */
624     libvlc_ArtRequest(libvlc, item);
625     return libvlc_MetaRequest(libvlc, item);
626 }
627
628 /**************************************************************************
629  * Parse the media and wait.
630  **************************************************************************/
631 void
632 libvlc_media_parse(libvlc_media_t *media)
633 {
634     vlc_mutex_lock(&media->parsed_lock);
635     if (!media->has_asked_preparse)
636     {
637         media->has_asked_preparse = true;
638         vlc_mutex_unlock(&media->parsed_lock);
639
640         if (media_parse(media))
641             /* Parse failed: do not wait! */
642             return;
643         vlc_mutex_lock(&media->parsed_lock);
644     }
645
646     while (!media->is_parsed)
647         vlc_cond_wait(&media->parsed_cond, &media->parsed_lock);
648     vlc_mutex_unlock(&media->parsed_lock);
649 }
650
651 /**************************************************************************
652  * Parse the media but do not wait.
653  **************************************************************************/
654 void
655 libvlc_media_parse_async(libvlc_media_t *media)
656 {
657     bool needed;
658
659     vlc_mutex_lock(&media->parsed_lock);
660     needed = !media->has_asked_preparse;
661     media->has_asked_preparse = true;
662     vlc_mutex_unlock(&media->parsed_lock);
663
664     if (needed)
665         media_parse(media);
666 }
667
668 /**************************************************************************
669  * Get parsed status for media object.
670  **************************************************************************/
671 int
672 libvlc_media_is_parsed(libvlc_media_t *media)
673 {
674     bool parsed;
675
676     vlc_mutex_lock(&media->parsed_lock);
677     parsed = media->is_parsed;
678     vlc_mutex_unlock(&media->parsed_lock);
679     return parsed;
680 }
681
682 /**************************************************************************
683  * Sets media descriptor's user_data. user_data is specialized data
684  * accessed by the host application, VLC.framework uses it as a pointer to
685  * an native object that references a libvlc_media_t pointer
686  **************************************************************************/
687 void
688 libvlc_media_set_user_data( libvlc_media_t * p_md, void * p_new_user_data )
689 {
690     assert( p_md );
691     p_md->p_user_data = p_new_user_data;
692 }
693
694 /**************************************************************************
695  * Get media descriptor's user_data. user_data is specialized data
696  * accessed by the host application, VLC.framework uses it as a pointer to
697  * an native object that references a libvlc_media_t pointer
698  **************************************************************************/
699 void *
700 libvlc_media_get_user_data( libvlc_media_t * p_md )
701 {
702     assert( p_md );
703     return p_md->p_user_data;
704 }
705
706 /**************************************************************************
707  * Get media descriptor's elementary streams description
708  **************************************************************************/
709 int
710 libvlc_media_get_tracks_info( libvlc_media_t *p_md, libvlc_media_track_info_t ** pp_es )
711 {
712     assert( p_md );
713
714     input_item_t *p_input_item = p_md->p_input_item;
715     vlc_mutex_lock( &p_input_item->lock );
716
717     const int i_es = p_input_item->i_es;
718     *pp_es = (i_es > 0) ? malloc( i_es * sizeof(libvlc_media_track_info_t) ) : NULL;
719
720     if( !*pp_es ) /* no ES, or OOM */
721     {
722         vlc_mutex_unlock( &p_input_item->lock );
723         return 0;
724     }
725
726     /* Fill array */
727     for( int i = 0; i < i_es; i++ )
728     {
729         libvlc_media_track_info_t *p_mes = *pp_es+i;
730         const es_format_t *p_es = p_input_item->es[i];
731
732         p_mes->i_codec = p_es->i_codec;
733         p_mes->i_id = p_es->i_id;
734
735         p_mes->i_profile = p_es->i_profile;
736         p_mes->i_level = p_es->i_level;
737
738         switch(p_es->i_cat)
739         {
740         case UNKNOWN_ES:
741         default:
742             p_mes->i_type = libvlc_track_unknown;
743             break;
744         case VIDEO_ES:
745             p_mes->i_type = libvlc_track_video;
746             p_mes->u.video.i_height = p_es->video.i_height;
747             p_mes->u.video.i_width = p_es->video.i_width;
748             break;
749         case AUDIO_ES:
750             p_mes->i_type = libvlc_track_audio;
751             p_mes->u.audio.i_channels = p_es->audio.i_channels;
752             p_mes->u.audio.i_rate = p_es->audio.i_rate;
753             break;
754         case SPU_ES:
755             p_mes->i_type = libvlc_track_text;
756             break;
757         }
758     }
759
760     vlc_mutex_unlock( &p_input_item->lock );
761     return i_es;
762 }
763
764 unsigned
765 libvlc_media_tracks_get( libvlc_media_t *p_md, libvlc_media_track_t *** pp_es )
766 {
767     assert( p_md );
768
769     input_item_t *p_input_item = p_md->p_input_item;
770     vlc_mutex_lock( &p_input_item->lock );
771
772     const int i_es = p_input_item->i_es;
773     *pp_es = (i_es > 0) ? calloc( i_es, sizeof(**pp_es) ) : NULL;
774
775     if( !*pp_es ) /* no ES, or OOM */
776     {
777         vlc_mutex_unlock( &p_input_item->lock );
778         return 0;
779     }
780
781     /* Fill array */
782     for( int i = 0; i < i_es; i++ )
783     {
784         libvlc_media_track_t *p_mes = calloc( 1, sizeof(*p_mes) );
785         if ( p_mes )
786         {
787             p_mes->audio = malloc( __MAX(__MAX(sizeof(*p_mes->audio),
788                                                sizeof(*p_mes->video)),
789                                                sizeof(*p_mes->subtitle)) );
790         }
791         if ( !p_mes || !p_mes->audio )
792         {
793             libvlc_media_tracks_release( *pp_es, i_es );
794             *pp_es = NULL;
795             free( p_mes );
796             vlc_mutex_unlock( &p_input_item->lock );
797             return 0;
798         }
799         (*pp_es)[i] = p_mes;
800
801         const es_format_t *p_es = p_input_item->es[i];
802
803         p_mes->i_codec = p_es->i_codec;
804         p_mes->i_original_fourcc = p_es->i_original_fourcc;
805         p_mes->i_id = p_es->i_id;
806
807         p_mes->i_profile = p_es->i_profile;
808         p_mes->i_level = p_es->i_level;
809
810         p_mes->i_bitrate = p_es->i_bitrate;
811         p_mes->psz_language = p_es->psz_language != NULL ? strdup(p_es->psz_language) : NULL;
812         p_mes->psz_description = p_es->psz_description != NULL ? strdup(p_es->psz_description) : NULL;
813
814         switch(p_es->i_cat)
815         {
816         case UNKNOWN_ES:
817         default:
818             p_mes->i_type = libvlc_track_unknown;
819             break;
820         case VIDEO_ES:
821             p_mes->i_type = libvlc_track_video;
822             p_mes->video->i_height = p_es->video.i_height;
823             p_mes->video->i_width = p_es->video.i_width;
824             p_mes->video->i_sar_num = p_es->video.i_sar_num;
825             p_mes->video->i_sar_den = p_es->video.i_sar_den;
826             p_mes->video->i_frame_rate_num = p_es->video.i_frame_rate;
827             p_mes->video->i_frame_rate_den = p_es->video.i_frame_rate_base;
828             break;
829         case AUDIO_ES:
830             p_mes->i_type = libvlc_track_audio;
831             p_mes->audio->i_channels = p_es->audio.i_channels;
832             p_mes->audio->i_rate = p_es->audio.i_rate;
833             break;
834         case SPU_ES:
835             p_mes->i_type = libvlc_track_text;
836             p_mes->subtitle->psz_encoding = p_es->subs.psz_encoding != NULL ?
837                                             strdup(p_es->subs.psz_encoding) : NULL;
838             break;
839         }
840     }
841
842     vlc_mutex_unlock( &p_input_item->lock );
843     return i_es;
844 }
845
846
847 /**************************************************************************
848  * Release media descriptor's elementary streams description array
849  **************************************************************************/
850 void libvlc_media_tracks_release( libvlc_media_track_t **p_tracks, unsigned i_count )
851 {
852     for( unsigned i = 0; i < i_count; ++i )
853     {
854         if ( !p_tracks[i] )
855             continue;
856         free( p_tracks[i]->psz_language );
857         free( p_tracks[i]->psz_description );
858         switch( p_tracks[i]->i_type )
859         {
860         case libvlc_track_audio:
861             break;
862         case libvlc_track_video:
863             break;
864         case libvlc_track_text:
865             free( p_tracks[i]->subtitle->psz_encoding );
866             break;
867         case libvlc_track_unknown:
868         default:
869             break;
870         }
871         free( p_tracks[i]->audio );
872         free( p_tracks[i] );
873     }
874     free( p_tracks );
875 }