1 /*****************************************************************************
2 * media_instance.c: Libvlc API Media Instance management functions
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@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 <vlc/libvlc.h>
25 #include <vlc_demux.h>
26 #include <vlc_input.h>
27 #include "libvlc_internal.h"
31 * Release the associated input thread
33 * Object lock is NOT held.
35 static void release_input_thread( libvlc_media_instance_t *p_mi )
37 input_thread_t *p_input_thread;
39 if( !p_mi || p_mi->i_input_id == -1 )
42 p_input_thread = (input_thread_t*)vlc_object_get(
43 p_mi->p_libvlc_instance->p_libvlc_int,
46 p_mi->i_input_id = -1;
51 /* release for previous vlc_object_get */
52 vlc_object_release( p_input_thread );
54 /* release for initial p_input_thread yield (see _new()) */
55 vlc_object_release( p_input_thread );
57 /* No one is tracking this input_thread appart us. Destroy it */
58 if( p_mi->b_own_its_input_thread )
60 /* We owned this one */
61 input_StopThread( p_input_thread );
62 var_Destroy( p_input_thread, "drawable" );
63 input_DestroyThread( p_input_thread );
67 /* XXX: hack the playlist doesn't retain the input thread,
68 * so we did it for the playlist (see _new_from_input_thread),
69 * revert that here. This will be deleted with the playlist API */
70 vlc_object_release( p_input_thread );
75 * Retrieve the input thread. Be sure to release the object
76 * once you are done with it. (libvlc Internal)
78 * Object lock is held.
80 input_thread_t *libvlc_get_input_thread( libvlc_media_instance_t *p_mi,
81 libvlc_exception_t *p_e )
83 input_thread_t *p_input_thread;
85 vlc_mutex_lock( &p_mi->object_lock );
87 if( !p_mi || p_mi->i_input_id == -1 )
89 vlc_mutex_unlock( &p_mi->object_lock );
90 RAISENULL( "Input is NULL" );
93 p_input_thread = (input_thread_t*)vlc_object_get(
94 p_mi->p_libvlc_instance->p_libvlc_int,
98 vlc_mutex_unlock( &p_mi->object_lock );
99 RAISENULL( "Input does not exist" );
102 vlc_mutex_unlock( &p_mi->object_lock );
103 return p_input_thread;
107 * input_state_changed (Private) (input var "state" Callback)
110 input_state_changed( vlc_object_t * p_this, char const * psz_cmd,
111 vlc_value_t oldval, vlc_value_t newval,
114 libvlc_media_instance_t * p_mi = p_userdata;
115 libvlc_event_t event;
117 if( newval.i_int == oldval.i_int )
118 return VLC_SUCCESS; /* No change since last time, don't propagate */
120 switch ( newval.i_int )
123 event.type = libvlc_MediaInstanceReachedEnd;
126 event.type = libvlc_MediaInstancePaused;
129 event.type = libvlc_MediaInstancePlayed;
135 libvlc_event_send( p_mi->p_event_manager, &event );
140 * input_position_changed (Private) (input var "intf-change" Callback)
143 input_position_changed( vlc_object_t * p_this, char const * psz_cmd,
144 vlc_value_t oldval, vlc_value_t newval,
147 libvlc_media_instance_t * p_mi = p_userdata;
150 if (!strcmp(psz_cmd, "intf" /* "-change" no need to go further */))
152 input_thread_t * p_input = (input_thread_t *)p_this;
153 var_Get( p_input, "position", &val );
155 if ((val.i_time % I64C(500000)) != 0)
156 return VLC_SUCCESS; /* No need to have a better precision */
157 var_Get( p_input, "state", &val );
159 if( val.i_int != PLAYING_S )
160 return VLC_SUCCESS; /* Don't send the position while stopped */
163 val.i_time = newval.i_time;
165 libvlc_event_t event;
166 event.type = libvlc_MediaInstancePositionChanged;
167 event.u.media_instance_position_changed.new_position = val.i_time;
169 libvlc_event_send( p_mi->p_event_manager, &event );
173 /**************************************************************************
174 * Create a Media Instance object
175 **************************************************************************/
176 libvlc_media_instance_t *
177 libvlc_media_instance_new( libvlc_instance_t * p_libvlc_instance,
178 libvlc_exception_t * p_e )
180 libvlc_media_instance_t * p_mi;
182 if( !p_libvlc_instance )
184 libvlc_exception_raise( p_e, "invalid libvlc instance" );
188 p_mi = malloc( sizeof(libvlc_media_instance_t) );
191 p_mi->p_libvlc_instance = p_libvlc_instance;
192 p_mi->i_input_id = -1;
193 /* refcount strategy:
194 * - All items created by _new start with a refcount set to 1
195 * - Accessor _release decrease the refcount by 1, if after that
196 * operation the refcount is 0, the object is destroyed.
197 * - Accessor _retain increase the refcount by 1 (XXX: to implement) */
198 p_mi->i_refcount = 1;
199 p_mi->b_own_its_input_thread = VLC_TRUE;
200 /* object_lock strategy:
201 * - No lock held in constructor
202 * - Lock when accessing all variable this lock is held
203 * - Lock when attempting to destroy the object the lock is also held */
204 vlc_mutex_init( p_mi->p_libvlc_instance->p_libvlc_int,
205 &p_mi->object_lock );
206 p_mi->p_event_manager = libvlc_event_manager_new( p_mi,
207 p_libvlc_instance, p_e );
208 if( libvlc_exception_raised( p_e ) )
214 libvlc_event_manager_register_event_type( p_mi->p_event_manager,
215 libvlc_MediaInstanceReachedEnd, p_e );
216 libvlc_event_manager_register_event_type( p_mi->p_event_manager,
217 libvlc_MediaInstancePaused, p_e );
218 libvlc_event_manager_register_event_type( p_mi->p_event_manager,
219 libvlc_MediaInstancePlayed, p_e );
220 libvlc_event_manager_register_event_type( p_mi->p_event_manager,
221 libvlc_MediaInstancePositionChanged, p_e );
226 /**************************************************************************
227 * Create a Media Instance object with a media descriptor
228 **************************************************************************/
229 libvlc_media_instance_t *
230 libvlc_media_instance_new_from_media_descriptor(
231 libvlc_media_descriptor_t * p_md,
232 libvlc_exception_t *p_e )
234 libvlc_media_instance_t * p_mi;
235 p_mi = libvlc_media_instance_new( p_md->p_libvlc_instance, p_e );
240 libvlc_media_descriptor_retain( p_md );
246 /**************************************************************************
247 * Create a new media instance object from an input_thread (Libvlc Internal)
248 **************************************************************************/
249 libvlc_media_instance_t * libvlc_media_instance_new_from_input_thread(
250 struct libvlc_instance_t *p_libvlc_instance,
251 input_thread_t *p_input,
252 libvlc_exception_t *p_e )
254 libvlc_media_instance_t * p_mi;
258 libvlc_exception_raise( p_e, "invalid input thread" );
262 p_mi = libvlc_media_instance_new( p_libvlc_instance, p_e );
267 p_mi->p_md = libvlc_media_descriptor_new_from_input_item(
269 input_GetItem( p_input ), p_e );
273 libvlc_media_instance_destroy( p_mi );
277 p_mi->i_input_id = p_input->i_object_id;
278 p_mi->b_own_its_input_thread = VLC_FALSE;
280 /* will be released in media_instance_release() */
281 vlc_object_yield( p_input );
283 /* XXX: Hack as the playlist doesn't yield the input thread we retain
284 * the input for the playlist. (see corresponding hack in _release) */
285 vlc_object_yield( p_input );
290 /**************************************************************************
291 * Destroy a Media Instance object (libvlc internal)
293 * Warning: No lock held here, but hey, this is internal.
294 **************************************************************************/
295 void libvlc_media_instance_destroy( libvlc_media_instance_t *p_mi )
297 input_thread_t *p_input_thread;
298 libvlc_exception_t p_e;
300 libvlc_exception_init( &p_e );
305 p_input_thread = libvlc_get_input_thread( p_mi, &p_e );
307 if( libvlc_exception_raised( &p_e ) )
309 libvlc_event_manager_release( p_mi->p_event_manager );
310 libvlc_exception_clear( &p_e );
312 return; /* no need to worry about no input thread */
314 vlc_mutex_destroy( &p_mi->object_lock );
316 input_DestroyThread( p_input_thread );
318 libvlc_media_descriptor_release( p_mi->p_md );
323 /**************************************************************************
324 * Release a Media Instance object
325 **************************************************************************/
326 void libvlc_media_instance_release( libvlc_media_instance_t *p_mi )
331 vlc_mutex_lock( &p_mi->object_lock );
335 if( p_mi->i_refcount > 0 )
337 vlc_mutex_unlock( &p_mi->object_lock );
340 vlc_mutex_unlock( &p_mi->object_lock );
341 vlc_mutex_destroy( &p_mi->object_lock );
343 release_input_thread( p_mi );
345 libvlc_event_manager_release( p_mi->p_event_manager );
347 libvlc_media_descriptor_release( p_mi->p_md );
352 /**************************************************************************
353 * Retain a Media Instance object
354 **************************************************************************/
355 void libvlc_media_instance_retain( libvlc_media_instance_t *p_mi )
363 /**************************************************************************
364 * Set the Media descriptor associated with the instance
365 **************************************************************************/
366 void libvlc_media_instance_set_media_descriptor(
367 libvlc_media_instance_t *p_mi,
368 libvlc_media_descriptor_t *p_md,
369 libvlc_exception_t *p_e )
376 vlc_mutex_lock( &p_mi->object_lock );
378 release_input_thread( p_mi );
380 libvlc_media_descriptor_release( p_mi->p_md );
385 vlc_mutex_unlock( &p_mi->object_lock );
386 return; /* It is ok to pass a NULL md */
389 libvlc_media_descriptor_retain( p_md );
392 /* The policy here is to ignore that we were created using a different
393 * libvlc_instance, because we don't really care */
394 p_mi->p_libvlc_instance = p_md->p_libvlc_instance;
396 vlc_mutex_unlock( &p_mi->object_lock );
399 /**************************************************************************
400 * Get the Media descriptor associated with the instance
401 **************************************************************************/
402 libvlc_media_descriptor_t *
403 libvlc_media_instance_get_media_descriptor(
404 libvlc_media_instance_t *p_mi,
405 libvlc_exception_t *p_e )
412 libvlc_media_descriptor_retain( p_mi->p_md );
416 /**************************************************************************
417 * Get the event Manager
418 **************************************************************************/
419 libvlc_event_manager_t *
420 libvlc_media_instance_event_manager(
421 libvlc_media_instance_t *p_mi,
422 libvlc_exception_t *p_e )
426 return p_mi->p_event_manager;
429 /**************************************************************************
431 **************************************************************************/
432 void libvlc_media_instance_play( libvlc_media_instance_t *p_mi,
433 libvlc_exception_t *p_e )
435 input_thread_t * p_input_thread;
437 if( (p_input_thread = libvlc_get_input_thread( p_mi, p_e )) )
439 /* A thread alread exists, send it a play message */
440 input_Control( p_input_thread, INPUT_SET_STATE, PLAYING_S );
441 vlc_object_release( p_input_thread );
445 /* Ignore previous exception */
446 libvlc_exception_clear( p_e );
448 vlc_mutex_lock( &p_mi->object_lock );
452 libvlc_exception_raise( p_e, "no associated media descriptor" );
453 vlc_mutex_unlock( &p_mi->object_lock );
457 p_input_thread = input_CreateThread( p_mi->p_libvlc_instance->p_libvlc_int,
458 p_mi->p_md->p_input_item );
459 p_mi->i_input_id = p_input_thread->i_object_id;
464 val.i_int = p_mi->drawable;
465 var_Create( p_input_thread, "drawable", VLC_VAR_DOINHERIT );
466 var_Set( p_input_thread, "drawable", val );
468 var_AddCallback( p_input_thread, "state", input_state_changed, p_mi );
469 var_AddCallback( p_input_thread, "intf-change", input_position_changed, p_mi );
471 /* will be released in media_instance_release() */
472 vlc_object_yield( p_input_thread );
474 vlc_mutex_unlock( &p_mi->object_lock );
477 /**************************************************************************
479 **************************************************************************/
480 void libvlc_media_instance_pause( libvlc_media_instance_t *p_mi,
481 libvlc_exception_t *p_e )
483 input_thread_t * p_input_thread = libvlc_get_input_thread( p_mi, p_e );
485 if( !p_input_thread )
488 input_Control( p_input_thread, INPUT_SET_STATE, PAUSE_S );
489 vlc_object_release( p_input_thread );
492 /**************************************************************************
494 **************************************************************************/
495 void libvlc_media_instance_stop( libvlc_media_instance_t *p_mi,
496 libvlc_exception_t *p_e )
498 if( p_mi->b_own_its_input_thread )
499 release_input_thread( p_mi ); /* This will stop the input thread */
502 input_thread_t * p_input_thread = libvlc_get_input_thread( p_mi, p_e );
504 if( !p_input_thread )
507 input_StopThread( p_input_thread );
508 vlc_object_release( p_input_thread );
512 /**************************************************************************
514 **************************************************************************/
515 void libvlc_media_instance_set_drawable( libvlc_media_instance_t *p_mi,
516 libvlc_drawable_t drawable,
517 libvlc_exception_t *p_e )
519 p_mi->drawable = drawable;
522 /**************************************************************************
523 * Getters for stream information
524 **************************************************************************/
525 vlc_int64_t libvlc_media_instance_get_length(
526 libvlc_media_instance_t *p_mi,
527 libvlc_exception_t *p_e )
529 input_thread_t *p_input_thread;
532 p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
533 if( !p_input_thread )
536 var_Get( p_input_thread, "length", &val );
537 vlc_object_release( p_input_thread );
539 return (val.i_time+500LL)/1000LL;
542 vlc_int64_t libvlc_media_instance_get_time(
543 libvlc_media_instance_t *p_mi,
544 libvlc_exception_t *p_e )
546 input_thread_t *p_input_thread;
549 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
550 if( !p_input_thread )
553 var_Get( p_input_thread , "time", &val );
554 vlc_object_release( p_input_thread );
555 return (val.i_time+500LL)/1000LL;
558 void libvlc_media_instance_set_time(
559 libvlc_media_instance_t *p_mi,
561 libvlc_exception_t *p_e )
563 input_thread_t *p_input_thread;
566 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
567 if( !p_input_thread )
570 value.i_time = time*1000LL;
571 var_Set( p_input_thread, "time", value );
572 vlc_object_release( p_input_thread );
575 void libvlc_media_instance_set_position(
576 libvlc_media_instance_t *p_mi,
578 libvlc_exception_t *p_e )
580 input_thread_t *p_input_thread;
582 val.f_float = position;
584 p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
585 if( !p_input_thread )
588 var_Set( p_input_thread, "position", val );
589 vlc_object_release( p_input_thread );
592 float libvlc_media_instance_get_position(
593 libvlc_media_instance_t *p_mi,
594 libvlc_exception_t *p_e )
596 input_thread_t *p_input_thread;
599 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
600 if( !p_input_thread )
603 var_Get( p_input_thread, "position", &val );
604 vlc_object_release( p_input_thread );
609 void libvlc_media_instance_set_chapter(
610 libvlc_media_instance_t *p_mi,
612 libvlc_exception_t *p_e )
614 input_thread_t *p_input_thread;
618 p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
619 if( !p_input_thread )
622 var_Set( p_input_thread, "chapter", val );
623 vlc_object_release( p_input_thread );
626 int libvlc_media_instance_get_chapter(
627 libvlc_media_instance_t *p_mi,
628 libvlc_exception_t *p_e )
630 input_thread_t *p_input_thread;
633 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
634 if( !p_input_thread )
637 var_Get( p_input_thread, "chapter", &val );
638 vlc_object_release( p_input_thread );
643 int libvlc_media_instance_get_chapter_count(
644 libvlc_media_instance_t *p_mi,
645 libvlc_exception_t *p_e )
647 input_thread_t *p_input_thread;
650 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
651 if( !p_input_thread )
654 var_Change( p_input_thread, "chapter", VLC_VAR_CHOICESCOUNT, &val, NULL );
655 vlc_object_release( p_input_thread );
660 float libvlc_media_instance_get_fps(
661 libvlc_media_instance_t *p_mi,
662 libvlc_exception_t *p_e)
664 input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
669 if( input_Control( p_input_thread, INPUT_GET_VIDEO_FPS, &f_fps ) )
671 vlc_object_release( p_input_thread );
676 vlc_bool_t libvlc_media_instance_will_play(
677 libvlc_media_instance_t *p_mi,
678 libvlc_exception_t *p_e)
680 input_thread_t *p_input_thread =
681 libvlc_get_input_thread ( p_mi, p_e);
682 if ( !p_input_thread )
685 if ( !p_input_thread->b_die && !p_input_thread->b_dead )
687 vlc_object_release( p_input_thread );
690 vlc_object_release( p_input_thread );
694 void libvlc_media_instance_set_rate(
695 libvlc_media_instance_t *p_mi,
697 libvlc_exception_t *p_e )
699 input_thread_t *p_input_thread;
703 RAISEVOID( "Rate value is invalid" );
705 val.i_int = 1000.0f/rate;
707 p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
708 if ( !p_input_thread )
711 var_Set( p_input_thread, "rate", val );
712 vlc_object_release( p_input_thread );
715 float libvlc_media_instance_get_rate(
716 libvlc_media_instance_t *p_mi,
717 libvlc_exception_t *p_e )
719 input_thread_t *p_input_thread;
722 p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
723 if ( !p_input_thread )
726 var_Get( p_input_thread, "rate", &val );
727 vlc_object_release( p_input_thread );
729 return (float)1000.0f/val.i_int;
732 static const libvlc_state_t vlc_to_libvlc_state[] =
734 [INIT_S] = libvlc_Opening,
735 [OPENING_S] = libvlc_Opening,
736 [BUFFERING_S] = libvlc_Buffering,
737 [PLAYING_S] = libvlc_Playing,
738 [PAUSE_S] = libvlc_Paused,
739 [END_S] = libvlc_Ended,
740 [ERROR_S] = libvlc_Error,
743 libvlc_state_t libvlc_media_instance_get_state(
744 libvlc_media_instance_t *p_mi,
745 libvlc_exception_t *p_e )
747 input_thread_t *p_input_thread;
750 p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
751 if ( !p_input_thread )
752 return libvlc_Stopped;
754 var_Get( p_input_thread, "state", &val );
755 vlc_object_release( p_input_thread );
757 if( val.i_int < 0 || val.i_int > 6 )
758 return libvlc_Stopped;
760 return vlc_to_libvlc_state[val.i_int];