include/vlc_input.h

   1 /*****************************************************************************
   2  * vlc_input.h: Core input structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /* __ is need because conflict with <vlc/input.h> */
  26 #ifndef VLC__INPUT_H
  27 #define VLC__INPUT_H 1
  28
  29 /**
  30  * \file
  31  * This file defines functions, structures and enums for input objects in vlc
  32  */
  33
  34 #include <vlc_es.h>
  35 #include <vlc_meta.h>
  36 #include <vlc_epg.h>
  37 #include <vlc_events.h>
  38 #include <vlc_input_item.h>
  39
  40 #include <string.h>
  41
  42 /*****************************************************************************
  43  * Meta data helpers
  44  *****************************************************************************/
  45 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
  46                                                         const vlc_meta_t *p_meta )
  47 {
  48     char * psz_value;
  49
  50     if( !p_meta )
  51         return;
  52
  53     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
  54         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
  55     {
  56         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
  57         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  58     }
  59     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
  60              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
  61     {
  62         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
  63         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
  64     }
  65     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
  66              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
  67     {
  68         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
  69         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  70     }
  71     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
  72     {
  73         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
  74         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
  75     }
  76 }
  77
  78 /*****************************************************************************
  79  * Seek point: (generalisation of chapters)
  80  *****************************************************************************/
  81 struct seekpoint_t
  82 {
  83     int64_t i_byte_offset;
  84     int64_t i_time_offset;
  85     char    *psz_name;
  86     int     i_level;
  87 };
  88
  89 static inline seekpoint_t *vlc_seekpoint_New( void )
  90 {
  91     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
  92     point->i_byte_offset =
  93     point->i_time_offset = -1;
  94     point->i_level = 0;
  95     point->psz_name = NULL;
  96     return point;
  97 }
  98
  99 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 100 {
 101     if( !point ) return;
 102     free( point->psz_name );
 103     free( point );
 104 }
 105
 106 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 107 {
 108     seekpoint_t *point = vlc_seekpoint_New();
 109     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 110     point->i_time_offset = src->i_time_offset;
 111     point->i_byte_offset = src->i_byte_offset;
 112     return point;
 113 }
 114
 115 /*****************************************************************************
 116  * Title:
 117  *****************************************************************************/
 118 typedef struct
 119 {
 120     char        *psz_name;
 121
 122     bool        b_menu;      /* Is it a menu or a normal entry */
 123
 124     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 125     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 126
 127     /* Title seekpoint */
 128     int         i_seekpoint;
 129     seekpoint_t **seekpoint;
 130
 131 } input_title_t;
 132
 133 static inline input_title_t *vlc_input_title_New(void)
 134 {
 135     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 136
 137     t->psz_name = NULL;
 138     t->b_menu = false;
 139     t->i_length = 0;
 140     t->i_size   = 0;
 141     t->i_seekpoint = 0;
 142     t->seekpoint = NULL;
 143
 144     return t;
 145 }
 146
 147 static inline void vlc_input_title_Delete( input_title_t *t )
 148 {
 149     int i;
 150     if( t == NULL )
 151         return;
 152
 153     free( t->psz_name );
 154     for( i = 0; i < t->i_seekpoint; i++ )
 155     {
 156         free( t->seekpoint[i]->psz_name );
 157         free( t->seekpoint[i] );
 158     }
 159     free( t->seekpoint );
 160     free( t );
 161 }
 162
 163 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 164 {
 165     input_title_t *dup = vlc_input_title_New( );
 166     int i;
 167
 168     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 169     dup->b_menu      = t->b_menu;
 170     dup->i_length    = t->i_length;
 171     dup->i_size      = t->i_size;
 172     dup->i_seekpoint = t->i_seekpoint;
 173     if( t->i_seekpoint > 0 )
 174     {
 175         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 176                                                 sizeof(seekpoint_t*) );
 177
 178         for( i = 0; i < t->i_seekpoint; i++ )
 179         {
 180             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 181         }
 182     }
 183
 184     return dup;
 185 }
 186
 187 /*****************************************************************************
 188  * Attachments
 189  *****************************************************************************/
 190 struct input_attachment_t
 191 {
 192     char *psz_name;
 193     char *psz_mime;
 194     char *psz_description;
 195
 196     int  i_data;
 197     void *p_data;
 198 };
 199
 200 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 201                                                             const char *psz_mime,
 202                                                             const char *psz_description,
 203                                                             const void *p_data,
 204                                                             int i_data )
 205 {
 206     input_attachment_t *a =
 207         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 208     if( !a )
 209         return NULL;
 210     a->psz_name = strdup( psz_name ? psz_name : "" );
 211     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 212     a->psz_description = strdup( psz_description ? psz_description : "" );
 213     a->i_data = i_data;
 214     a->p_data = NULL;
 215     if( i_data > 0 )
 216     {
 217         a->p_data = malloc( i_data );
 218         if( a->p_data && p_data )
 219             memcpy( a->p_data, p_data, i_data );
 220     }
 221     return a;
 222 }
 223 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 224 {
 225     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 226                                      a->p_data, a->i_data );
 227 }
 228 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 229 {
 230     if( !a )
 231         return;
 232     free( a->psz_name );
 233     free( a->psz_mime );
 234     free( a->psz_description );
 235     free( a->p_data );
 236     free( a );
 237 }
 238
 239 /*****************************************************************************
 240  * input defines/constants.
 241  *****************************************************************************/
 242
 243 /* i_update field of access_t/demux_t */
 244 #define INPUT_UPDATE_NONE       0x0000
 245 #define INPUT_UPDATE_SIZE       0x0001
 246 #define INPUT_UPDATE_TITLE      0x0010
 247 #define INPUT_UPDATE_SEEKPOINT  0x0020
 248 #define INPUT_UPDATE_META       0x0040
 249 #define INPUT_UPDATE_SIGNAL     0x0080
 250
 251 /** Get the input item for an input thread
 252  * FIXME see src/input/item.c but is is unsafe unless
 253  * you hold p_input
 254  */
 255 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 256
 257 typedef struct input_thread_private_t input_thread_private_t;
 258
 259 /**
 260  * Main structure representing an input thread. This structure is mostly
 261  * private. The only public fields are READ-ONLY. You must use the helpers
 262  * to modify them
 263  */
 264 struct input_thread_t
 265 {
 266     VLC_COMMON_MEMBERS;
 267
 268     bool b_eof;
 269     bool b_preparsing;
 270     bool b_dead;
 271
 272     /* All other data is input_thread is PRIVATE. You can't access it
 273      * outside of src/input */
 274     input_thread_private_t *p;
 275 };
 276
 277 /**
 278  * Record prefix string.
 279  * TODO make it configurable.
 280  */
 281 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
 282
 283 /*****************************************************************************
 284  * Input events and variables
 285  *****************************************************************************/
 286
 287 /**
 288  * \defgroup inputvariable Input variables
 289  *
 290  * The input provides multiples variable you can write to and/or read from.
 291  *
 292  * TODO complete the documentation.
 293  * The read only variables are:
 294  *  - "length"
 295  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
 296  *    or not, for that check position != 0.0)
 297  *  - "can-pause"
 298  *  - "can-rate"
 299  *  - "can-rewind"
 300  *  - "can-record" (if a stream can be recorded while playing)
 301  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 302  *                   variable value being the one currently selected, -1 if no teletext)
 303  *  - "signal-quality"
 304  *  - "signal-strength"
 305  *  - "program-scrambled" (if the current program is scrambled)
 306  *  - "cache" (level of data cached [0 .. 1])
 307  *
 308  * The read-write variables are:
 309  *  - state (\see input_state_e)
 310  *  - rate, rate-slower, rate-faster
 311  *  - position, position-offset
 312  *  - time, time-offset
 313  *  - title, next-title, prev-title
 314  *  - chapter, next-chapter, next-chapter-prev
 315  *  - program, audio-es, video-es, spu-es
 316  *  - audio-delay, spu-delay
 317  *  - bookmark (bookmark list)
 318  *  - record
 319  *  - frame-next
 320  *  - navigation (list of "title %2i")
 321  *  - "title %2i"
 322  *
 323  * The variable used for event is
 324  *  - intf-event (\see input_event_type_e)
 325  */
 326
 327 /**
 328  * Input state
 329  *
 330  * This enum is used by the variable "state"
 331  */
 332 typedef enum input_state_e
 333 {
 334     INIT_S = 0,
 335     OPENING_S,
 336     PLAYING_S,
 337     PAUSE_S,
 338     END_S,
 339     ERROR_S,
 340 } input_state_e;
 341
 342 /**
 343  * Input rate.
 344  *
 345  * It is an integer used by the variable "rate" in the
 346  * range [INPUT_RATE_MIN, INPUT_RATE_MAX] the default value
 347  * being INPUT_RATE_DEFAULT.
 348  *
 349  * A value lower than INPUT_RATE_DEFAULT plays faster.
 350  * A value higher than INPUT_RATE_DEFAULT plays slower.
 351  */
 352
 353 /**
 354  * Default rate value
 355  */
 356 #define INPUT_RATE_DEFAULT  1000
 357 /**
 358  * Minimal rate value
 359  */
 360 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
 361 /**
 362  * Maximal rate value
 363  */
 364 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 365
 366 /**
 367  * Input events
 368  *
 369  * You can catch input event by adding a callback on the variable "intf-event".
 370  * This variable is an integer that will hold a input_event_type_e value.
 371  */
 372 typedef enum input_event_type_e
 373 {
 374     /* "state" has changed */
 375     INPUT_EVENT_STATE,
 376     /* b_dead is true */
 377     INPUT_EVENT_DEAD,
 378     /* a *user* abort has been requested */
 379     INPUT_EVENT_ABORT,
 380
 381     /* "rate" has changed */
 382     INPUT_EVENT_RATE,
 383
 384     /* At least one of "position" or "time" or "length" has changed */
 385     INPUT_EVENT_TIMES,
 386
 387     /* A title has been added or removed or selected.
 388      * It imply that chapter has changed (not chapter event is sent) */
 389     INPUT_EVENT_TITLE,
 390     /* A chapter has been added or removed or selected. */
 391     INPUT_EVENT_CHAPTER,
 392
 393     /* A program ("program") has been added or removed or selected,
 394      * or "program-scrambled" has changed.*/
 395     INPUT_EVENT_PROGRAM,
 396     /* A ES has been added or removed or selected */
 397     INPUT_EVENT_ES,
 398     /* "teletext-es" has changed */
 399     INPUT_EVENT_TELETEXT,
 400
 401     /* "record" has changed */
 402     INPUT_EVENT_RECORD,
 403
 404     /* input_item_t media has changed */
 405     INPUT_EVENT_ITEM_META,
 406     /* input_item_t info has changed */
 407     INPUT_EVENT_ITEM_INFO,
 408     /* input_item_t name has changed */
 409     INPUT_EVENT_ITEM_NAME,
 410
 411     /* Input statistics have been updated */
 412     INPUT_EVENT_STATISTICS,
 413     /* At least one of "signal-quality" or "signal-strength" has changed */
 414     INPUT_EVENT_SIGNAL,
 415
 416     /* "audio-delay" has changed */
 417     INPUT_EVENT_AUDIO_DELAY,
 418     /* "spu-delay" has changed */
 419     INPUT_EVENT_SUBTITLE_DELAY,
 420
 421     /* "bookmark" has changed */
 422     INPUT_EVENT_BOOKMARK,
 423
 424     /* cache" has changed */
 425     INPUT_EVENT_CACHE,
 426
 427     /* A aout_instance_t object has been created/deleted by *the input* */
 428     INPUT_EVENT_AOUT,
 429     /* A vout_thread_t object has been created/deleted by *the input* */
 430     INPUT_EVENT_VOUT,
 431
 432 } input_event_type_e;
 433
 434 /** @}*/
 435
 436 /*****************************************************************************
 437  * Prototypes
 438  *****************************************************************************/
 439
 440 /**
 441  * It will create a new input thread.
 442  *
 443  * You must call input_StopThread() on it and then vlc_object_release().
 444  */
 445 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 446 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 447
 448 /**
 449  * It will ask a input_thread_t to stop.
 450  *
 451  * b_abort must be true when a user stop is requested and not because you have
 452  * detected an error or an eof. It will be used to properly send the
 453  * INPUT_EVENT_ABORT event.
 454  */
 455 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t *, bool b_abort ) );
 456
 457 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 458 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
 459
 460 enum input_query_e
 461 {
 462     /* input variable "position" */
 463     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 464     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 465
 466     /* input variable "length" */
 467     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 468
 469     /* input variable "time" */
 470     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 471     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 472
 473     /* input variable "rate" (1 is DEFAULT_RATE) */
 474     INPUT_GET_RATE,             /* arg1= int *          res=    */
 475     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 476
 477     /* input variable "state" */
 478     INPUT_GET_STATE,            /* arg1= int *          res=    */
 479     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 480
 481     /* input variable "audio-delay" and "sub-delay" */
 482     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 483     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 484     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 485     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 486
 487     /* Meta datas */
 488     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 489     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 490     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 491     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 492
 493     /* Input config options */
 494     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 495
 496     /* Input properties */
 497     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
 498
 499     /* bookmarks */
 500     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 501     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 502     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 503     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 504     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 505     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 506     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 507
 508     /* Attachments */
 509     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 510     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 511
 512     /* On the fly input slave */
 513     INPUT_ADD_SLAVE,       /* arg1= const char * */
 514     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
 515
 516     /* On the fly record while playing */
 517     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
 518     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
 519
 520     /* ES */
 521     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 522
 523     /* Input ressources
 524      * XXX You must call vlc_object_release as soon as possible */
 525     INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
 526     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, int *        res=can fail */
 527 };
 528
 529 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 530 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 531
 532 /**
 533  * It will return the current state of the input.
 534  * Provided for convenience.
 535  */
 536 static inline input_state_e input_GetState( input_thread_t * p_input )
 537 {
 538     input_state_e state = INIT_S;
 539     input_Control( p_input, INPUT_GET_STATE, &state );
 540     return state;
 541 }
 542 /**
 543  * It will add a new subtitle source to the input.
 544  * Provided for convenience.
 545  */
 546 static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
 547 {
 548     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
 549 }
 550
 551 /**
 552  * Return one of the video output (if any). If possible, you should use
 553  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 554  * @param p_input an input thread from which to get a video output
 555  * @return NULL on error, or a video output thread pointer (which needs to be
 556  * released with vlc_object_release()).
 557  */
 558 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
 559 {
 560      vout_thread_t **pp_vout, *p_vout;
 561      unsigned i_vout;
 562
 563      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
 564          return NULL;
 565
 566      for( unsigned i = 1; i < i_vout; i++ )
 567          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
 568
 569      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
 570      free (pp_vout);
 571      return p_vout;
 572 }
 573
 574 /**
 575  * Return the audio output (if any) associated with an input.
 576  * @param p_input an input thread
 577  * @return NULL on error, or the audio output (which needs to be
 578  * released with vlc_object_release()).
 579  */
 580 static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
 581 {
 582      aout_instance_t *p_aout;
 583      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
 584 }
 585
 586 /* */
 587 typedef struct input_clock_t input_clock_t;
 588 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
 589 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 590 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 591
 592 /**
 593  * This function allows to split a MRL into access, demux and path part.
 594  *
 595  *  You should not write into access and demux string as they may not point into
 596  * the provided buffer.
 597  *  The buffer provided by psz_dup will be modified.
 598  */
 599 VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
 600
 601 /**
 602  * This function creates a sane filename path.
 603  */
 604 VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );
 605
 606 #endif