git.sesse.net Git - vlc/blob - src/control/media_instance.c

   1 /*****************************************************************************
   2  * media_instance.c: Libvlc API Media Instance management functions
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@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 #include <vlc/libvlc.h>
  26 #include <vlc_demux.h>
  27 #include <vlc_input.h>
  28 #include "input/input_internal.h"
  29
  30 /*
  31  * Release the associated input thread
  32  *
  33  * Object lock is NOT held.
  34  */
  35 static void release_input_thread( libvlc_media_instance_t *p_mi )
  36 {
  37     input_thread_t *p_input_thread;
  38     vlc_bool_t should_destroy;
  39
  40     if( !p_mi || p_mi->i_input_id == -1 )
  41         return;
  42
  43     p_input_thread = (input_thread_t*)vlc_object_get(
  44                                              p_mi->p_libvlc_instance->p_libvlc_int,
  45                                              p_mi->i_input_id );
  46
  47     p_mi->i_input_id = -1;
  48
  49     if( !p_input_thread )
  50         return;
  51
  52     /* release for previous vlc_object_get */
  53     vlc_object_release( p_input_thread );
  54
  55     should_destroy = p_input_thread->i_refcount == 1;
  56
  57     /* release for initial p_input_thread yield (see _new()) */
  58     vlc_object_release( p_input_thread );
  59
  60     /* No one is tracking this input_thread appart us. Destroy it */
  61     if( should_destroy )
  62         input_DestroyThread( p_input_thread );
  63     else
  64     {
  65         /* XXX: hack the playlist doesn't retain the input thread,
  66          * so we did it for the playlist (see _new_from_input_thread),
  67          * revert that here. */
  68         vlc_object_release( p_input_thread );
  69     }
  70 }
  71
  72 /*
  73  * Retrieve the input thread. Be sure to release the object
  74  * once you are done with it. (libvlc Internal)
  75  *
  76  * Object lock is held.
  77  */
  78 input_thread_t *libvlc_get_input_thread( libvlc_media_instance_t *p_mi,
  79                                          libvlc_exception_t *p_e )
  80 {
  81     input_thread_t *p_input_thread;
  82
  83     vlc_mutex_lock( &p_mi->object_lock );
  84
  85     if( !p_mi || p_mi->i_input_id == -1 )
  86     {
  87         vlc_mutex_unlock( &p_mi->object_lock );
  88         RAISENULL( "Input is NULL" );
  89     }
  90
  91     p_input_thread = (input_thread_t*)vlc_object_get(
  92                                              p_mi->p_libvlc_instance->p_libvlc_int,
  93                                              p_mi->i_input_id );
  94     if( !p_input_thread )
  95     {
  96         vlc_mutex_unlock( &p_mi->object_lock );
  97         RAISENULL( "Input does not exist" );
  98     }
  99
 100     vlc_mutex_unlock( &p_mi->object_lock );
 101     return p_input_thread;
 102 }
 103
 104 /*
 105  * input_state_changed (Private) (input var "state" Callback)
 106  */
 107 static int
 108 input_state_changed( vlc_object_t * p_this, char const * psz_cmd,
 109                      vlc_value_t oldval, vlc_value_t newval,
 110                      void * p_userdata )
 111 {
 112     libvlc_media_instance_t * p_mi = p_userdata;
 113     libvlc_event_t event;
 114
 115     if( newval.i_int == oldval.i_int )
 116         return VLC_SUCCESS; /* No change since last time, don't propagate */
 117
 118     switch ( newval.i_int )
 119     {
 120         case END_S:
 121             event.type = libvlc_MediaInstanceReachedEnd;
 122             break;
 123         default:
 124             return VLC_SUCCESS;
 125     }
 126
 127     libvlc_event_send( p_mi->p_event_manager, &event );
 128     return VLC_SUCCESS;
 129 }
 130
 131 /**************************************************************************
 132  * Create a Media Instance object
 133  **************************************************************************/
 134 libvlc_media_instance_t *
 135 libvlc_media_instance_new( libvlc_instance_t * p_libvlc_instance,
 136                            libvlc_exception_t * p_e )
 137 {
 138     libvlc_media_instance_t * p_mi;
 139
 140     if( !p_libvlc_instance )
 141     {
 142         libvlc_exception_raise( p_e, "invalid libvlc instance" );
 143         return NULL;
 144     }
 145
 146     p_mi = malloc( sizeof(libvlc_media_instance_t) );
 147     p_mi->p_md = NULL;
 148     p_mi->drawable = 0;
 149     p_mi->p_libvlc_instance = p_libvlc_instance;
 150     p_mi->i_input_id = -1;
 151     /* refcount strategy:
 152      * - All items created by _new start with a refcount set to 1
 153      * - Accessor _release decrease the refcount by 1, if after that
 154      *   operation the refcount is 0, the object is destroyed.
 155      * - Accessor _retain increase the refcount by 1 (XXX: to implement) */
 156     p_mi->i_refcount = 1;
 157     /* object_lock strategy:
 158      * - No lock held in constructor
 159      * - Lock when accessing all variable this lock is held
 160      * - Lock when attempting to destroy the object the lock is also held */
 161     vlc_mutex_init( p_mi->p_libvlc_instance->p_libvlc_int,
 162                     &p_mi->object_lock );
 163     p_mi->p_event_manager = libvlc_event_manager_new( p_mi,
 164             p_libvlc_instance, p_e );
 165     if( libvlc_exception_raised( p_e ) )
 166     {
 167         free( p_mi );
 168         return NULL;
 169     }
 170
 171     libvlc_event_manager_register_event_type( p_mi->p_event_manager,
 172             libvlc_MediaInstanceReachedEnd, p_e );
 173
 174     return p_mi;
 175 }
 176
 177 /**************************************************************************
 178  * Create a Media Instance object with a media descriptor
 179  **************************************************************************/
 180 libvlc_media_instance_t *
 181 libvlc_media_instance_new_from_media_descriptor(
 182                                     libvlc_media_descriptor_t * p_md,
 183                                     libvlc_exception_t *p_e )
 184 {
 185     libvlc_media_instance_t * p_mi;
 186     p_mi = libvlc_media_instance_new( p_md->p_libvlc_instance, p_e );
 187
 188     if( !p_mi )
 189         return NULL;
 190
 191     p_mi->p_md = libvlc_media_descriptor_duplicate( p_md );
 192
 193     return p_mi;
 194 }
 195
 196 /**************************************************************************
 197  * Create a new media instance object from an input_thread (Libvlc Internal)
 198  **************************************************************************/
 199 libvlc_media_instance_t * libvlc_media_instance_new_from_input_thread(
 200                                    struct libvlc_instance_t *p_libvlc_instance,
 201                                    input_thread_t *p_input,
 202                                    libvlc_exception_t *p_e )
 203 {
 204     libvlc_media_instance_t * p_mi;
 205
 206     if( !p_input )
 207     {
 208         libvlc_exception_raise( p_e, "invalid input thread" );
 209         return NULL;
 210     }
 211
 212     p_mi = libvlc_media_instance_new( p_libvlc_instance, p_e );
 213
 214     if( !p_mi )
 215         return NULL;
 216
 217     p_mi->p_md = libvlc_media_descriptor_new_from_input_item(
 218                     p_libvlc_instance,
 219                     p_input->p->input.p_item, p_e );
 220
 221     if( !p_mi->p_md )
 222     {
 223         libvlc_media_instance_destroy( p_mi );
 224         return NULL;
 225     }
 226
 227     p_mi->i_input_id = p_input->i_object_id;
 228
 229     /* will be released in media_instance_release() */
 230     vlc_object_yield( p_input );
 231
 232     /* XXX: Hack as the playlist doesn't yield the input thread we retain
 233      * the input for the playlist. (see corresponding hack in _release) */
 234     vlc_object_yield( p_input );
 235
 236     return p_mi;
 237 }
 238
 239 /**************************************************************************
 240  * Destroy a Media Instance object (libvlc internal)
 241  *
 242  * Warning: No lock held here, but hey, this is internal.
 243  **************************************************************************/
 244 void libvlc_media_instance_destroy( libvlc_media_instance_t *p_mi )
 245 {
 246     input_thread_t *p_input_thread;
 247     libvlc_exception_t p_e;
 248
 249     libvlc_exception_init( &p_e );
 250
 251     if( !p_mi )
 252         return;
 253
 254     p_input_thread = libvlc_get_input_thread( p_mi, &p_e );
 255
 256     if( libvlc_exception_raised( &p_e ) )
 257     {
 258         libvlc_event_manager_release( p_mi->p_event_manager );
 259         free( p_mi );
 260         return; /* no need to worry about no input thread */
 261     }
 262
 263     input_DestroyThread( p_input_thread );
 264
 265     libvlc_media_descriptor_release( p_mi->p_md );
 266
 267     free( p_mi );
 268 }
 269
 270 /**************************************************************************
 271  * Release a Media Instance object
 272  **************************************************************************/
 273 void libvlc_media_instance_release( libvlc_media_instance_t *p_mi )
 274 {
 275     if( !p_mi )
 276         return;
 277
 278     vlc_mutex_lock( &p_mi->object_lock );
 279
 280     p_mi->i_refcount--;
 281
 282     if( p_mi->i_refcount > 0 )
 283     {
 284         vlc_mutex_unlock( &p_mi->object_lock );
 285         return;
 286     }
 287     vlc_mutex_unlock( &p_mi->object_lock );
 288
 289     libvlc_event_manager_release( p_mi->p_event_manager );
 290
 291     release_input_thread( p_mi );
 292
 293     libvlc_media_descriptor_release( p_mi->p_md );
 294
 295     free( p_mi );
 296 }
 297
 298 /**************************************************************************
 299  * Retain a Media Instance object
 300  **************************************************************************/
 301 void libvlc_media_instance_retain( libvlc_media_instance_t *p_mi )
 302 {
 303     if( !p_mi )
 304         return;
 305
 306     p_mi->i_refcount++;
 307 }
 308 /**************************************************************************
 309  * Set the Media descriptor associated with the instance
 310  **************************************************************************/
 311 void libvlc_media_instance_set_media_descriptor(
 312                             libvlc_media_instance_t *p_mi,
 313                             libvlc_media_descriptor_t *p_md,
 314                             libvlc_exception_t *p_e )
 315 {
 316     (void)p_e;
 317
 318     if( !p_mi )
 319         return;
 320
 321     vlc_mutex_lock( &p_mi->object_lock );
 322
 323     release_input_thread( p_mi );
 324
 325     libvlc_media_descriptor_release( p_mi->p_md );
 326
 327     if( !p_md )
 328     {
 329         p_mi->p_md = NULL;
 330         vlc_mutex_unlock( &p_mi->object_lock );
 331         return; /* It is ok to pass a NULL md */
 332     }
 333
 334     p_mi->p_md = libvlc_media_descriptor_duplicate( p_md );
 335
 336     /* The policy here is to ignore that we were created using a different
 337      * libvlc_instance, because we don't really care */
 338     p_mi->p_libvlc_instance = p_md->p_libvlc_instance;
 339
 340     vlc_mutex_unlock( &p_mi->object_lock );
 341 }
 342
 343 /**************************************************************************
 344  * Get the Media descriptor associated with the instance
 345  **************************************************************************/
 346 libvlc_media_descriptor_t *
 347 libvlc_media_instance_get_media_descriptor(
 348                             libvlc_media_instance_t *p_mi,
 349                             libvlc_exception_t *p_e )
 350 {
 351     (void)p_e;
 352
 353     if( !p_mi->p_md )
 354         return NULL;
 355
 356     return libvlc_media_descriptor_duplicate( p_mi->p_md );
 357 }
 358
 359 /**************************************************************************
 360  * Get the event Manager
 361  **************************************************************************/
 362 libvlc_event_manager_t *
 363 libvlc_media_instance_event_manager(
 364                             libvlc_media_instance_t *p_mi,
 365                             libvlc_exception_t *p_e )
 366 {
 367     (void)p_e;
 368
 369     if( !p_mi->p_md )
 370         return NULL;
 371
 372     return p_mi->p_event_manager;
 373 }
 374
 375 /**************************************************************************
 376  * Play
 377  **************************************************************************/
 378 void libvlc_media_instance_play( libvlc_media_instance_t *p_mi,
 379                                  libvlc_exception_t *p_e )
 380 {
 381     input_thread_t * p_input_thread;
 382
 383     if( (p_input_thread = libvlc_get_input_thread( p_mi, p_e )) )
 384     {
 385         /* A thread alread exists, send it a play message */
 386         vlc_value_t val;
 387         val.i_int = PLAYING_S;
 388
 389         input_Control( p_input_thread, INPUT_CONTROL_SET_STATE, PLAYING_S );
 390         vlc_object_release( p_input_thread );
 391         return;
 392     }
 393
 394     vlc_mutex_lock( &p_mi->object_lock );
 395
 396     if( !p_mi->p_md )
 397     {
 398         libvlc_exception_raise( p_e, "no associated media descriptor" );
 399         vlc_mutex_unlock( &p_mi->object_lock );
 400         return;
 401     }
 402
 403     p_input_thread = input_CreateThread( p_mi->p_libvlc_instance->p_libvlc_int,
 404                                          p_mi->p_md->p_input_item );
 405     p_mi->i_input_id = p_input_thread->i_object_id;
 406
 407     if( p_mi->drawable )
 408     {
 409         vlc_value_t val;
 410         val.i_int = p_mi->drawable;
 411         var_Set( p_input_thread, "drawable", val );
 412     }
 413     var_AddCallback( p_input_thread, "state", input_state_changed, p_mi );
 414
 415     /* will be released in media_instance_release() */
 416     vlc_object_yield( p_input_thread );
 417
 418     vlc_mutex_unlock( &p_mi->object_lock );
 419 }
 420
 421 /**************************************************************************
 422  * Pause
 423  **************************************************************************/
 424 void libvlc_media_instance_pause( libvlc_media_instance_t *p_mi,
 425                                   libvlc_exception_t *p_e )
 426 {
 427     input_thread_t * p_input_thread;
 428     vlc_value_t val;
 429     val.i_int = PAUSE_S;
 430
 431     p_input_thread = libvlc_get_input_thread( p_mi, p_e );
 432
 433     if( !p_input_thread )
 434         return;
 435
 436     input_Control( p_input_thread, INPUT_CONTROL_SET_STATE, val );
 437     vlc_object_release( p_input_thread );
 438 }
 439
 440 /**************************************************************************
 441  * Stop
 442  **************************************************************************/
 443 void libvlc_media_instance_stop( libvlc_media_instance_t *p_mi,
 444                                  libvlc_exception_t *p_e )
 445 {
 446     libvlc_exception_raise( p_e, "Not implemented" );
 447 }
 448
 449 /**************************************************************************
 450  * Set Drawable
 451  **************************************************************************/
 452 void libvlc_media_instance_set_drawable( libvlc_media_instance_t *p_mi,
 453                                          libvlc_drawable_t drawable,
 454                                          libvlc_exception_t *p_e )
 455 {
 456     p_mi->drawable = drawable;
 457 }
 458
 459 /**************************************************************************
 460  * Getters for stream information
 461  **************************************************************************/
 462 vlc_int64_t libvlc_media_instance_get_length(
 463                              libvlc_media_instance_t *p_mi,
 464                              libvlc_exception_t *p_e )
 465 {
 466     input_thread_t *p_input_thread;
 467     vlc_value_t val;
 468
 469     p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
 470     if( !p_input_thread )
 471         return -1;
 472
 473     var_Get( p_input_thread, "length", &val );
 474     vlc_object_release( p_input_thread );
 475
 476     return (val.i_time+500LL)/1000LL;
 477 }
 478
 479 vlc_int64_t libvlc_media_instance_get_time(
 480                                    libvlc_media_instance_t *p_mi,
 481                                    libvlc_exception_t *p_e )
 482 {
 483     input_thread_t *p_input_thread;
 484     vlc_value_t val;
 485
 486     p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
 487     if( !p_input_thread )
 488         return -1;
 489
 490     var_Get( p_input_thread , "time", &val );
 491     vlc_object_release( p_input_thread );
 492     return (val.i_time+500LL)/1000LL;
 493 }
 494
 495 void libvlc_media_instance_set_time(
 496                                  libvlc_media_instance_t *p_mi,
 497                                  vlc_int64_t time,
 498                                  libvlc_exception_t *p_e )
 499 {
 500     input_thread_t *p_input_thread;
 501     vlc_value_t value;
 502
 503     p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
 504     if( !p_input_thread )
 505         return;
 506
 507     value.i_time = time*1000LL;
 508     var_Set( p_input_thread, "time", value );
 509     vlc_object_release( p_input_thread );
 510 }
 511
 512 void libvlc_media_instance_set_position(
 513                                 libvlc_media_instance_t *p_mi,
 514                                 float position,
 515                                 libvlc_exception_t *p_e )
 516 {
 517     input_thread_t *p_input_thread;
 518     vlc_value_t val;
 519     val.f_float = position;
 520
 521     p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
 522     if( !p_input_thread )
 523         return;
 524
 525     var_Set( p_input_thread, "position", val );
 526     vlc_object_release( p_input_thread );
 527 }
 528
 529 float libvlc_media_instance_get_position(
 530                                  libvlc_media_instance_t *p_mi,
 531                                  libvlc_exception_t *p_e )
 532 {
 533     input_thread_t *p_input_thread;
 534     vlc_value_t val;
 535
 536     p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
 537     if( !p_input_thread )
 538         return -1.0;
 539
 540     var_Get( p_input_thread, "position", &val );
 541     vlc_object_release( p_input_thread );
 542
 543     return val.f_float;
 544 }
 545
 546 float libvlc_media_instance_get_fps(
 547                                  libvlc_media_instance_t *p_mi,
 548                                  libvlc_exception_t *p_e)
 549 {
 550     double f_fps = 0.0;
 551     input_thread_t *p_input_thread;
 552
 553     p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
 554     if( !p_input_thread )
 555         return 0.0;
 556
 557     if( (NULL == p_input_thread->p->input.p_demux)
 558         || demux2_Control( p_input_thread->p->input.p_demux, DEMUX_GET_FPS, &f_fps )
 559         || f_fps < 0.1 )
 560     {
 561         vlc_object_release( p_input_thread );
 562         return 0.0;
 563     }
 564     else
 565     {
 566         vlc_object_release( p_input_thread );
 567         return( f_fps );
 568     }
 569 }
 570
 571 vlc_bool_t libvlc_media_instance_will_play(
 572                                  libvlc_media_instance_t *p_mi,
 573                                  libvlc_exception_t *p_e)
 574 {
 575     input_thread_t *p_input_thread =
 576                             libvlc_get_input_thread ( p_mi, p_e);
 577     if ( !p_input_thread )
 578         return VLC_FALSE;
 579
 580     if ( !p_input_thread->b_die && !p_input_thread->b_dead )
 581     {
 582         vlc_object_release( p_input_thread );
 583         return VLC_TRUE;
 584     }
 585     vlc_object_release( p_input_thread );
 586     return VLC_FALSE;
 587 }
 588
 589 void libvlc_media_instance_set_rate(
 590                                  libvlc_media_instance_t *p_mi,
 591                                  float rate,
 592                                  libvlc_exception_t *p_e )
 593 {
 594     input_thread_t *p_input_thread;
 595     vlc_value_t val;
 596
 597     if( rate <= 0 )
 598         RAISEVOID( "Rate value is invalid" );
 599
 600     val.i_int = 1000.0f/rate;
 601
 602     p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
 603     if ( !p_input_thread )
 604         return;
 605
 606     var_Set( p_input_thread, "rate", val );
 607     vlc_object_release( p_input_thread );
 608 }
 609
 610 float libvlc_media_instance_get_rate(
 611                                  libvlc_media_instance_t *p_mi,
 612                                  libvlc_exception_t *p_e )
 613 {
 614     input_thread_t *p_input_thread;
 615     vlc_value_t val;
 616
 617     p_input_thread = libvlc_get_input_thread ( p_mi, p_e);
 618     if ( !p_input_thread )
 619         return -1.0;
 620
 621     var_Get( p_input_thread, "rate", &val );
 622     vlc_object_release( p_input_thread );
 623
 624     return (float)1000.0f/val.i_int;
 625 }
 626
 627 int libvlc_media_instance_get_state(
 628                                  libvlc_media_instance_t *p_mi,
 629                                  libvlc_exception_t *p_e )
 630 {
 631     input_thread_t *p_input_thread;
 632     vlc_value_t val;
 633
 634     p_input_thread = libvlc_get_input_thread ( p_mi, p_e );
 635     if ( !p_input_thread )
 636         return 0;
 637
 638     var_Get( p_input_thread, "state", &val );
 639     vlc_object_release( p_input_thread );
 640
 641     return val.i_int;
 642 }
 643