src/control/vlm.c

   1 /*****************************************************************************
   2  * vlm.c: libvlc new API VLM handling 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
  26 #include <vlc/libvlc.h>
  27 #include <vlc_es.h>
  28 #include <vlc_input.h>
  29 #include <vlc_vlm.h>
  30
  31 #if 0
  32 /* local function to be used in libvlc_vlm_show_media only */
  33 static char* recurse_answer( char* psz_prefix, vlm_message_t *p_answer ) {
  34     char* psz_childprefix;
  35     char* psz_response="";
  36     char* response_tmp;
  37     int i;
  38     vlm_message_t *aw_child, **paw_child;
  39
  40     asprintf( &psz_childprefix, "%s%s.", psz_prefix, p_answer->psz_name );
  41
  42     if ( p_answer->i_child )
  43     {
  44         paw_child = p_answer->child;
  45         aw_child = *( paw_child );
  46         for( i = 0; i < p_answer->i_child; i++ )
  47         {
  48             asprintf( &response_tmp, "%s%s%s:%s\n",
  49                       psz_response, psz_prefix, aw_child->psz_name,
  50                       aw_child->psz_value );
  51             free( psz_response );
  52             psz_response = response_tmp;
  53             if ( aw_child->i_child )
  54             {
  55                 asprintf(&response_tmp, "%s%s", psz_response,
  56                          recurse_answer(psz_childprefix, aw_child));
  57                 free( psz_response );
  58                 psz_response = response_tmp;
  59             }
  60             paw_child++;
  61             aw_child = *( paw_child );
  62         }
  63     }
  64     free( psz_childprefix );
  65     return psz_response;
  66 }
  67
  68 char* libvlc_vlm_show_media( libvlc_instance_t *p_instance, char *psz_name,
  69                              libvlc_exception_t *p_exception )
  70 {
  71     char *psz_message;
  72     vlm_message_t *answer;
  73     char *psz_response;
  74
  75     CHECK_VLM;
  76 #ifdef ENABLE_VLM
  77     asprintf( &psz_message, "show %s", psz_name );
  78     asprintf( &psz_response, "", psz_name );
  79     vlm_ExecuteCommand( p_instance->p_vlm, psz_message, &answer );
  80     if( answer->psz_value )
  81     {
  82         libvlc_exception_raise( p_exception, "Unable to call show %s: %s",
  83                                 psz_name, answer->psz_value );
  84     }
  85     else
  86     {
  87         if ( answer->child )
  88         {
  89             psz_response = recurse_answer( "", answer );
  90         }
  91     }
  92     free( psz_message );
  93     return(psz_response );
  94 #else
  95     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
  96     return NULL;
  97 #endif
  98 }
  99 #endif /* 0 */
 100
 101 static int libvlc_vlm_init( libvlc_instance_t *p_instance,
 102                             libvlc_exception_t *p_exception )
 103 {
 104 #ifdef ENABLE_VLM
 105     if( !p_instance->p_vlm )
 106         p_instance->p_vlm = vlm_New( p_instance->p_libvlc_int );
 107 #else
 108     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 109     return VLC_EGENERIC;
 110 #endif
 111
 112     if( !p_instance->p_vlm )
 113     {
 114         libvlc_exception_raise( p_exception,
 115                                 "Unable to create VLM." );
 116         return VLC_EGENERIC;
 117     }
 118     return VLC_SUCCESS;
 119 }
 120 #define VLM_RET(p,ret) do {                                     \
 121     if( libvlc_vlm_init( p_instance, p_exception ) ) return ret;\
 122     (p) = p_instance->p_vlm;                                    \
 123   } while(0)
 124 #define VLM(p) VLM_RET(p,)
 125
 126 static vlm_media_instance_t *libvlc_vlm_get_media_instance( libvlc_instance_t *p_instance,
 127                                                             char *psz_name, int i_minstance_idx,
 128                                                             libvlc_exception_t *p_exception )
 129 {
 130 #ifdef ENABLE_VLM
 131     vlm_t *p_vlm;
 132     vlm_media_instance_t **pp_minstance;
 133     vlm_media_instance_t *p_minstance;
 134     int i_minstance;
 135     int64_t id;
 136
 137     VLM_RET(p_vlm, NULL);
 138
 139     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 140         vlm_Control( p_vlm, VLM_GET_MEDIA_INSTANCES, id, &pp_minstance, &i_minstance ) )
 141     {
 142         libvlc_exception_raise( p_exception, "Unable to get %s instances", psz_name );
 143         return NULL;
 144     }
 145     p_minstance = NULL;
 146     if( i_minstance_idx >= 0 && i_minstance_idx < i_minstance )
 147     {
 148         p_minstance = pp_minstance[i_minstance_idx];
 149         TAB_REMOVE( i_minstance, pp_minstance, p_minstance );
 150     }
 151     while( i_minstance > 0 )
 152         vlm_media_instance_Delete( pp_minstance[--i_minstance] );
 153     TAB_CLEAN( i_minstance, pp_minstance );
 154     return p_minstance;
 155 #else
 156     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 157     return VLC_EGENERIC;
 158 #endif
 159 }
 160
 161
 162 void libvlc_vlm_release( libvlc_instance_t *p_instance, libvlc_exception_t *p_exception)
 163 {
 164 #ifdef ENABLE_VLM
 165     vlm_t *p_vlm;
 166
 167     VLM(p_vlm);
 168
 169     vlm_Delete( p_vlm );
 170 #else
 171     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 172     return VLC_EGENERIC;
 173 #endif
 174 }
 175
 176
 177 void libvlc_vlm_add_broadcast( libvlc_instance_t *p_instance, char *psz_name,
 178                                char *psz_input, char *psz_output,
 179                                int i_options, char **ppsz_options,
 180                                int b_enabled, int b_loop,
 181                                libvlc_exception_t *p_exception )
 182 {
 183 #ifdef ENABLE_VLM
 184     vlm_t *p_vlm;
 185     vlm_media_t m;
 186     int n;
 187
 188     VLM(p_vlm);
 189
 190     vlm_media_Init( &m );
 191     m.psz_name = strdup( psz_name );
 192     m.b_enabled = b_enabled;
 193     m.b_vod = false;
 194     m.broadcast.b_loop = b_loop;
 195     if( psz_input )
 196         TAB_APPEND( m.i_input, m.ppsz_input, strdup(psz_input) );
 197     if( psz_output )
 198         m.psz_output = strdup( psz_output );
 199     for( n = 0; n < i_options; n++ )
 200         TAB_APPEND( m.i_option, m.ppsz_option, strdup(ppsz_options[n]) );
 201
 202     if( vlm_Control( p_vlm, VLM_ADD_MEDIA, &m, NULL ) )
 203     {
 204         vlm_media_Clean( &m );
 205         libvlc_exception_raise( p_exception, "Media %s creation failed", psz_name );
 206     }
 207     vlm_media_Clean( &m );
 208 #else
 209     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 210     return VLC_EGENERIC;
 211 #endif
 212 }
 213
 214 void libvlc_vlm_add_vod( libvlc_instance_t *p_instance, char *psz_name,
 215                          char *psz_input, int i_options,
 216                          char **ppsz_options, int b_enabled,
 217                          char *psz_mux, libvlc_exception_t *p_exception )
 218 {
 219 #ifdef ENABLE_VLM
 220     vlm_t *p_vlm;
 221     vlm_media_t m;
 222     int n;
 223
 224     VLM(p_vlm);
 225
 226     vlm_media_Init( &m );
 227     m.psz_name = strdup( psz_name );
 228     m.b_enabled = b_enabled;
 229     m.b_vod = true;
 230     m.vod.psz_mux = psz_mux ? strdup( psz_mux ) : NULL;
 231     if( psz_input )
 232         TAB_APPEND( m.i_input, m.ppsz_input, strdup(psz_input) );
 233     for( n = 0; n < i_options; n++ )
 234         TAB_APPEND( m.i_option, m.ppsz_option, strdup(ppsz_options[n]) );
 235
 236     if( vlm_Control( p_vlm, VLM_ADD_MEDIA, &m, NULL ) )
 237     {
 238         vlm_media_Clean( &m );
 239         libvlc_exception_raise( p_exception, "Media %s creation failed", psz_name );
 240     }
 241     vlm_media_Clean( &m );
 242 #else
 243     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 244     return VLC_EGENERIC;
 245 #endif
 246 }
 247
 248 void libvlc_vlm_del_media( libvlc_instance_t *p_instance, char *psz_name,
 249                            libvlc_exception_t *p_exception )
 250 {
 251 #ifdef ENABLE_VLM
 252     vlm_t *p_vlm;
 253     int64_t id;
 254
 255     VLM(p_vlm);
 256
 257     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 258         vlm_Control( p_vlm, VLM_DEL_MEDIA, id ) )
 259     {
 260         libvlc_exception_raise( p_exception, "Unable to delete %s", psz_name );
 261     }
 262 #else
 263     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 264     return VLC_EGENERIC;
 265 #endif
 266 }
 267
 268 #define VLM_CHANGE(psz_error, code ) do {   \
 269     vlm_media_t *p_media;   \
 270     vlm_t *p_vlm;           \
 271     int64_t id;             \
 272     VLM(p_vlm);             \
 273     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||    \
 274         vlm_Control( p_vlm, VLM_GET_MEDIA, id, &p_media ) ) {       \
 275         libvlc_exception_raise( p_exception, psz_error, psz_name ); \
 276         return;             \
 277     }                       \
 278     if( !p_media ) goto error;                                      \
 279                             \
 280     code;                   \
 281                             \
 282     if( vlm_Control( p_vlm, VLM_CHANGE_MEDIA, p_media ) ) {         \
 283         vlm_media_Delete( p_media );                                \
 284         goto error;         \
 285     }                       \
 286     vlm_media_Delete( p_media );                                    \
 287     return;                 \
 288   error:                    \
 289     libvlc_exception_raise( p_exception, psz_error, psz_name );\
 290   } while(0)
 291
 292 void libvlc_vlm_set_enabled( libvlc_instance_t *p_instance, char *psz_name,
 293                              int b_enabled, libvlc_exception_t *p_exception )
 294 {
 295 #ifdef ENABLE_VLM
 296 #define VLM_CHANGE_CODE { p_media->b_enabled = b_enabled; }
 297     VLM_CHANGE( "Unable to delete %s", VLM_CHANGE_CODE );
 298 #undef VLM_CHANGE_CODE
 299 #else
 300     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 301     return VLC_EGENERIC;
 302 #endif
 303 }
 304
 305 void libvlc_vlm_set_loop( libvlc_instance_t *p_instance, char *psz_name,
 306                           int b_loop, libvlc_exception_t *p_exception )
 307 {
 308 #ifdef ENABLE_VLM
 309 #define VLM_CHANGE_CODE { p_media->broadcast.b_loop = b_loop; }
 310     VLM_CHANGE( "Unable to change %s loop property", VLM_CHANGE_CODE );
 311 #undef VLM_CHANGE_CODE
 312 #else
 313     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 314     return VLC_EGENERIC;
 315 #endif
 316 }
 317
 318 void libvlc_vlm_set_mux( libvlc_instance_t *p_instance, char *psz_name,
 319                          char *psz_mux, libvlc_exception_t *p_exception )
 320 {
 321 #ifdef ENABLE_VLM
 322 #define VLM_CHANGE_CODE { if( p_media->b_vod ) { \
 323                             free( p_media->vod.psz_mux ); \
 324                             p_media->vod.psz_mux = psz_mux ? strdup( psz_mux ) : NULL; \
 325                           } }
 326     VLM_CHANGE( "Unable to change %s mux property", VLM_CHANGE_CODE );
 327 #undef VLM_CHANGE_CODE
 328 #else
 329     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 330     return VLC_EGENERIC;
 331 #endif
 332 }
 333
 334 void libvlc_vlm_set_output( libvlc_instance_t *p_instance, char *psz_name,
 335                             char *psz_output,  libvlc_exception_t *p_exception )
 336 {
 337 #ifdef ENABLE_VLM
 338 #define VLM_CHANGE_CODE { free( p_media->psz_output ); \
 339                           p_media->psz_output = strdup( psz_output ); }
 340     VLM_CHANGE( "Unable to change %s output property", VLM_CHANGE_CODE );
 341 #undef VLM_CHANGE_CODE
 342 #else
 343     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 344     return VLC_EGENERIC;
 345 #endif
 346 }
 347
 348 void libvlc_vlm_set_input( libvlc_instance_t *p_instance, char *psz_name,
 349                            char *psz_input,  libvlc_exception_t *p_exception )
 350 {
 351 #ifdef ENABLE_VLM
 352 #define VLM_CHANGE_CODE { while( p_media->i_input > 0 ) \
 353                             free( p_media->ppsz_input[--p_media->i_input] );\
 354                           TAB_APPEND( p_media->i_input, p_media->ppsz_input, strdup(psz_input) ); }
 355     VLM_CHANGE( "Unable to change %s input property", VLM_CHANGE_CODE );
 356 #undef VLM_CHANGE_CODE
 357 #else
 358     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 359     return VLC_EGENERIC;
 360 #endif
 361 }
 362
 363 void libvlc_vlm_add_input( libvlc_instance_t *p_instance, char *psz_name,
 364                            char *psz_input,  libvlc_exception_t *p_exception )
 365 {
 366 #ifdef ENABLE_VLM
 367 #define VLM_CHANGE_CODE { TAB_APPEND( p_media->i_input, p_media->ppsz_input, strdup(psz_input) ); }
 368     VLM_CHANGE( "Unable to change %s input property", VLM_CHANGE_CODE );
 369 #undef VLM_CHANGE_CODE
 370 #else
 371     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 372     return VLC_EGENERIC;
 373 #endif
 374 }
 375
 376 void libvlc_vlm_change_media( libvlc_instance_t *p_instance, char *psz_name,
 377                               char *psz_input, char *psz_output, int i_options,
 378                               char **ppsz_options, int b_enabled, int b_loop,
 379                               libvlc_exception_t *p_exception )
 380 {
 381 #ifdef ENABLE_VLM
 382 #define VLM_CHANGE_CODE { int n;        \
 383     p_media->b_enabled = b_enabled;     \
 384     p_media->broadcast.b_loop = b_loop; \
 385     while( p_media->i_input > 0 )       \
 386         free( p_media->ppsz_input[--p_media->i_input] );    \
 387     if( psz_input )                     \
 388         TAB_APPEND( p_media->i_input, p_media->ppsz_input, strdup(psz_input) ); \
 389     free( p_media->psz_output );        \
 390     p_media->psz_output = psz_output ? strdup( psz_output ) : NULL; \
 391     while( p_media->i_option > 0 )     \
 392         free( p_media->ppsz_option[--p_media->i_option] );        \
 393     for( n = 0; n < i_options; n++ )    \
 394         TAB_APPEND( p_media->i_option, p_media->ppsz_option, strdup(ppsz_options[n]) );   \
 395   }
 396     VLM_CHANGE( "Unable to change %s properties", VLM_CHANGE_CODE );
 397 #undef VLM_CHANGE_CODE
 398 #else
 399     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 400     return VLC_EGENERIC;
 401 #endif
 402 }
 403
 404 void libvlc_vlm_play_media( libvlc_instance_t *p_instance, char *psz_name,
 405                             libvlc_exception_t *p_exception )
 406 {
 407 #ifdef ENABLE_VLM
 408     vlm_t *p_vlm;
 409     int64_t id;
 410
 411     VLM(p_vlm);
 412
 413     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 414         vlm_Control( p_vlm, VLM_START_MEDIA_BROADCAST_INSTANCE, id, NULL, 0 ) )
 415     {
 416         libvlc_exception_raise( p_exception, "Unable to play %s", psz_name );
 417     }
 418 #else
 419     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 420     return VLC_EGENERIC;
 421 #endif
 422 }
 423
 424 void libvlc_vlm_stop_media( libvlc_instance_t *p_instance, char *psz_name,
 425                             libvlc_exception_t *p_exception )
 426 {
 427 #ifdef ENABLE_VLM
 428     vlm_t *p_vlm;
 429     int64_t id;
 430
 431     VLM(p_vlm);
 432
 433     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 434         vlm_Control( p_vlm, VLM_STOP_MEDIA_INSTANCE, id, NULL ) )
 435     {
 436         libvlc_exception_raise( p_exception, "Unable to stop %s", psz_name );
 437     }
 438 #else
 439     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 440     return VLC_EGENERIC;
 441 #endif
 442 }
 443
 444 void libvlc_vlm_pause_media( libvlc_instance_t *p_instance, char *psz_name,
 445                             libvlc_exception_t *p_exception )
 446 {
 447 #ifdef ENABLE_VLM
 448     vlm_t *p_vlm;
 449     int64_t id;
 450
 451     VLM(p_vlm);
 452
 453     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 454         vlm_Control( p_vlm, VLM_PAUSE_MEDIA_INSTANCE, id, NULL ) )
 455     {
 456         libvlc_exception_raise( p_exception, "Unable to pause %s", psz_name );
 457     }
 458 #else
 459     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 460     return VLC_EGENERIC;
 461 #endif
 462 }
 463
 464 void libvlc_vlm_seek_media( libvlc_instance_t *p_instance, char *psz_name,
 465                             float f_percentage, libvlc_exception_t *p_exception )
 466 {
 467 #ifdef ENABLE_VLM
 468     vlm_t *p_vlm;
 469     int64_t id;
 470
 471     VLM(p_vlm);
 472
 473     if( vlm_Control( p_vlm, VLM_GET_MEDIA_ID, psz_name, &id ) ||
 474         vlm_Control( p_vlm, VLM_SET_MEDIA_INSTANCE_POSITION, id, NULL, f_percentage ) )
 475     {
 476         libvlc_exception_raise( p_exception, "Unable to seek %s to %f", psz_name, f_percentage );
 477     }
 478 #else
 479     libvlc_exception_raise( p_exception, "VLM has been disabled in this libvlc." );
 480     return VLC_EGENERIC;
 481 #endif
 482 }
 483
 484 #define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, ret, code )\
 485 returnType libvlc_vlm_get_media_instance_## attr( libvlc_instance_t *p_instance, \
 486                         char *psz_name, int i_instance, libvlc_exception_t *p_exception ) \
 487 { \
 488     vlm_media_instance_t *p_mi = libvlc_vlm_get_media_instance( p_instance, psz_name, i_instance, \
 489                                                                 p_exception );  \
 490     if( p_mi ) {                            \
 491         returnType ret_value;               \
 492         code;                               \
 493         vlm_media_instance_Delete( p_mi );  \
 494         return ret_value;                   \
 495     }                                       \
 496     libvlc_exception_raise( p_exception, "Unable to get %s "#attr "attribute" ); \
 497     return ret; \
 498 }
 499
 500 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( position, float, Float, -1, ret_value = p_mi->d_position; );
 501 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( time,     int, Integer, -1, ret_value = p_mi->i_time );
 502 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( length,   int, Integer, -1, ret_value = p_mi->i_length );
 503 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( rate,     int, Integer, -1, ret_value = p_mi->i_rate );
 504 /* FIXME extend vlm_media_instance_t to be able to implement them */
 505 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( title,    int, Integer,  0, ret_value = 0 );
 506 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( chapter,  int, Integer,  0, ret_value = 0 );
 507 LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( seekable, int, Bool,     0, ret_value = false );
 508
 509 #undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
 510
 511 char* libvlc_vlm_show_media( libvlc_instance_t *p_instance, char *psz_name,
 512                              libvlc_exception_t *p_exception )
 513 {
 514     (void)p_instance;
 515     /* FIXME is it needed ? */
 516     libvlc_exception_raise( p_exception, "Unable to call show %s", psz_name );
 517     return NULL;
 518 }