vlc_input.h 19.4 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
2
 * vlc_input.h: Core input structures
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
4
 * Copyright (C) 1999-2006 the VideoLAN team
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Laurent Aimar's avatar
Laurent Aimar committed
23 24 25
 *****************************************************************************/

/* __ is need because conflict with <vlc/input.h> */
26 27
#ifndef VLC__INPUT_H
#define VLC__INPUT_H 1
Laurent Aimar's avatar
Laurent Aimar committed
28

29 30 31 32 33
/**
 * \file
 * This file defines functions, structures and enums for input objects in vlc
 */

34
#include <vlc_es.h>
35
#include <vlc_meta.h>
Laurent Aimar's avatar
Laurent Aimar committed
36
#include <vlc_epg.h>
37
#include <vlc_events.h>
38
#include <vlc_input_item.h>
39

40
#include <string.h>
41

42 43 44 45 46 47
/*****************************************************************************
 * Meta data helpers
 *****************************************************************************/
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
                                                        const vlc_meta_t *p_meta )
{
48 49
    char * psz_value;

50 51 52
    if( !p_meta )
        return;

53 54
    if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
        (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 58 59 60 61
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
    {
62
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
63 64 65 66 67
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
    {
68
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
69 70 71 72
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
    {
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
    }
}

Laurent Aimar's avatar
Laurent Aimar committed
78 79 80 81 82 83 84 85
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
86
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
87 88 89 90 91 92
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
93
    point->i_time_offset = -1;
94
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
95 96 97 98 99 100 101
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
102
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    free( point );
}

static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
{
    seekpoint_t *point = vlc_seekpoint_New();
    if( src->psz_name ) point->psz_name = strdup( src->psz_name );
    point->i_time_offset = src->i_time_offset;
    point->i_byte_offset = src->i_byte_offset;
    return point;
}

/*****************************************************************************
 * Title:
 *****************************************************************************/
typedef struct
{
    char        *psz_name;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
122
    bool        b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
123 124 125 126 127 128 129 130 131 132

    int64_t     i_length;   /* Length(microsecond) if known, else 0 */
    int64_t     i_size;     /* Size (bytes) if known, else 0 */

    /* Title seekpoint */
    int         i_seekpoint;
    seekpoint_t **seekpoint;

} input_title_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
133
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
134 135 136 137
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
138
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
139 140 141 142 143 144 145
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
146

Laurent Aimar's avatar
Laurent Aimar committed
147 148 149 150 151 152
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

153
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
154 155
    for( i = 0; i < t->i_seekpoint; i++ )
    {
156
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
157 158
        free( t->seekpoint[i] );
    }
159
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    free( t );
}

static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
{
    input_title_t *dup = vlc_input_title_New( );
    int i;

    if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
    dup->b_menu      = t->b_menu;
    dup->i_length    = t->i_length;
    dup->i_size      = t->i_size;
    dup->i_seekpoint = t->i_seekpoint;
    if( t->i_seekpoint > 0 )
    {
        dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
                                                sizeof(seekpoint_t*) );

        for( i = 0; i < t->i_seekpoint; i++ )
        {
            dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
        }
    }

    return dup;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
186

187 188 189 190 191 192 193 194
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
195

196 197 198
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
199

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
                                                            const char *psz_mime,
                                                            const char *psz_description,
                                                            const void *p_data,
                                                            int i_data )
{
    input_attachment_t *a =
        (input_attachment_t*)malloc( sizeof(input_attachment_t) );
    if( !a )
        return NULL;
    a->psz_name = strdup( psz_name ? psz_name : "" );
    a->psz_mime = strdup( psz_mime ? psz_mime : "" );
    a->psz_description = strdup( psz_description ? psz_description : "" );
    a->i_data = i_data;
    a->p_data = NULL;
    if( i_data > 0 )
    {
        a->p_data = malloc( i_data );
        if( a->p_data && p_data )
            memcpy( a->p_data, p_data, i_data );
    }
    return a;
}
static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
{
    return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
                                     a->p_data, a->i_data );
}
static inline void vlc_input_attachment_Delete( input_attachment_t *a )
{
    if( !a )
        return;
    free( a->psz_name );
    free( a->psz_mime );
    free( a->psz_description );
235
    free( a->p_data );
236 237
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
238

Laurent Aimar's avatar
Laurent Aimar committed
239 240 241 242 243 244 245 246 247
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* i_update field of access_t/demux_t */
#define INPUT_UPDATE_NONE       0x0000
#define INPUT_UPDATE_SIZE       0x0001
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
248
#define INPUT_UPDATE_META       0x0040
249
#define INPUT_UPDATE_SIGNAL     0x0080
Laurent Aimar's avatar
Laurent Aimar committed
250

251 252 253 254
/** Get the input item for an input thread
 * FIXME see src/input/item.c but is is unsafe unless
 * you hold p_input
 */
Clément Stenac's avatar
Clément Stenac committed
255 256 257 258 259 260 261 262 263
VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));

typedef struct input_thread_private_t input_thread_private_t;

/**
 * Main structure representing an input thread. This structure is mostly
 * private. The only public fields are READ-ONLY. You must use the helpers
 * to modify them
 */
Laurent Aimar's avatar
Laurent Aimar committed
264 265
struct input_thread_t
{
Clément Stenac's avatar
Clément Stenac committed
266
    VLC_COMMON_MEMBERS;
Laurent Aimar's avatar
Laurent Aimar committed
267

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
268
    bool b_eof;
269
    bool b_preparsing;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
270
    bool b_dead;
271

Clément Stenac's avatar
Clément Stenac committed
272 273 274
    /* All other data is input_thread is PRIVATE. You can't access it
     * outside of src/input */
    input_thread_private_t *p;
Laurent Aimar's avatar
Laurent Aimar committed
275 276
};

277 278 279 280 281 282
/**
 * Record prefix string.
 * TODO make it configurable.
 */
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"

Laurent Aimar's avatar
Laurent Aimar committed
283 284 285 286 287 288 289 290 291 292 293 294
/*****************************************************************************
 * Input events and variables
 *****************************************************************************/

/**
 * \defgroup inputvariable Input variables
 *
 * The input provides multiples variable you can write to and/or read from.
 *
 * TODO complete the documentation.
 * The read only variables are:
 *  - "length"
295
 *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
Laurent Aimar's avatar
Laurent Aimar committed
296 297
 *    or not, for that check position != 0.0)
 *  - "can-pause"
298
 *  - "can-rate"
Laurent Aimar's avatar
Laurent Aimar committed
299 300
 *  - "can-rewind"
 *  - "can-record" (if a stream can be recorded while playing)
301 302
 *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 *                   variable value being the one currently selected, -1 if no teletext)
303 304
 *  - "signal-quality"
 *  - "signal-strength"
305
 *  - "program-scrambled" (if the current program is scrambled)
306
 *  - "cache" (level of data cached [0 .. 1])
Laurent Aimar's avatar
Laurent Aimar committed
307 308 309 310 311 312
 *
 * The read-write variables are:
 *  - state (\see input_state_e)
 *  - rate, rate-slower, rate-faster
 *  - position, position-offset
 *  - time, time-offset
313 314
 *  - title, next-title, prev-title
 *  - chapter, next-chapter, next-chapter-prev
Laurent Aimar's avatar
Laurent Aimar committed
315 316
 *  - program, audio-es, video-es, spu-es
 *  - audio-delay, spu-delay
317
 *  - bookmark (bookmark list)
318 319 320 321
 *  - record
 *  - frame-next
 *  - navigation (list of "title %2i")
 *  - "title %2i"
Laurent Aimar's avatar
Laurent Aimar committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
 *
 * The variable used for event is
 *  - intf-event (\see input_event_type_e)
 */

/**
 * Input state
 *
 * This enum is used by the variable "state"
 */
typedef enum input_state_e
{
    INIT_S = 0,
    OPENING_S,
    PLAYING_S,
    PAUSE_S,
    END_S,
    ERROR_S,
} input_state_e;

/**
 * Input rate.
 *
 * It is an integer used by the variable "rate" in the
 * range [INPUT_RATE_MIN, INPUT_RATE_MAX] the default value
 * being INPUT_RATE_DEFAULT.
 *
 * A value lower than INPUT_RATE_DEFAULT plays faster.
 * A value higher than INPUT_RATE_DEFAULT plays slower.
 */

/**
 * Default rate value
 */
#define INPUT_RATE_DEFAULT  1000
/**
 * Minimal rate value
 */
#define INPUT_RATE_MIN        32            /* Up to 32/1 */
/**
 * Maximal rate value
 */
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */

/**
 * Input events
 *
 * You can catch input event by adding a callback on the variable "intf-event".
 * This variable is an integer that will hold a input_event_type_e value.
 */
typedef enum input_event_type_e
{
    /* "state" has changed */
    INPUT_EVENT_STATE,
Laurent Aimar's avatar
Laurent Aimar committed
376 377
    /* b_dead is true */
    INPUT_EVENT_DEAD,
378 379
    /* a *user* abort has been requested */
    INPUT_EVENT_ABORT,
Laurent Aimar's avatar
Laurent Aimar committed
380

Laurent Aimar's avatar
Laurent Aimar committed
381 382
    /* "rate" has changed */
    INPUT_EVENT_RATE,
Laurent Aimar's avatar
Laurent Aimar committed
383

Laurent Aimar's avatar
Laurent Aimar committed
384 385 386 387 388 389 390 391 392
    /* At least one of "position" or "time" or "length" has changed */
    INPUT_EVENT_TIMES,

    /* A title has been added or removed or selected.
     * It imply that chapter has changed (not chapter event is sent) */
    INPUT_EVENT_TITLE,
    /* A chapter has been added or removed or selected. */
    INPUT_EVENT_CHAPTER,

393 394
    /* A program ("program") has been added or removed or selected,
     * or "program-scrambled" has changed.*/
Laurent Aimar's avatar
Laurent Aimar committed
395 396 397
    INPUT_EVENT_PROGRAM,
    /* A ES has been added or removed or selected */
    INPUT_EVENT_ES,
Laurent Aimar's avatar
Laurent Aimar committed
398 399
    /* "teletext-es" has changed */
    INPUT_EVENT_TELETEXT,
Laurent Aimar's avatar
Laurent Aimar committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

    /* "record" has changed */
    INPUT_EVENT_RECORD,

    /* input_item_t media has changed */
    INPUT_EVENT_ITEM_META,
    /* input_item_t info has changed */
    INPUT_EVENT_ITEM_INFO,
    /* input_item_t name has changed */
    INPUT_EVENT_ITEM_NAME,

    /* Input statistics have been updated */
    INPUT_EVENT_STATISTICS,
    /* At least one of "signal-quality" or "signal-strength" has changed */
    INPUT_EVENT_SIGNAL,

    /* "audio-delay" has changed */
    INPUT_EVENT_AUDIO_DELAY,
    /* "spu-delay" has changed */
    INPUT_EVENT_SUBTITLE_DELAY,

421 422 423
    /* "bookmark" has changed */
    INPUT_EVENT_BOOKMARK,

424 425 426
    /* cache" has changed */
    INPUT_EVENT_CACHE,

427 428 429 430 431
    /* A aout_instance_t object has been created/deleted by *the input* */
    INPUT_EVENT_AOUT,
    /* A vout_thread_t object has been created/deleted by *the input* */
    INPUT_EVENT_VOUT,

Laurent Aimar's avatar
Laurent Aimar committed
432 433 434 435
} input_event_type_e;

/** @}*/

Laurent Aimar's avatar
Laurent Aimar committed
436 437 438
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
439

440 441 442 443 444
/**
 * It will create a new input thread.
 *
 * You must call input_StopThread() on it and then vlc_object_release().
 */
Laurent Aimar's avatar
Laurent Aimar committed
445 446
#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
447

448 449 450 451 452 453 454 455
/**
 * It will ask a input_thread_t to stop.
 *
 * b_abort must be true when a user stop is requested and not because you have
 * detected an error or an eof. It will be used to properly send the
 * INPUT_EVENT_ABORT event.
 */
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 ) );
Laurent Aimar's avatar
Laurent Aimar committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

enum input_query_e
{
    /* input variable "position" */
    INPUT_GET_POSITION,         /* arg1= double *       res=    */
    INPUT_SET_POSITION,         /* arg1= double         res=can fail    */

    /* input variable "length" */
    INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */

    /* input variable "time" */
    INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
    INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */

    /* input variable "rate" (1 is DEFAULT_RATE) */
    INPUT_GET_RATE,             /* arg1= int *          res=    */
    INPUT_SET_RATE,             /* arg1= int            res=can fail    */

    /* input variable "state" */
    INPUT_GET_STATE,            /* arg1= int *          res=    */
    INPUT_SET_STATE,            /* arg1= int            res=can fail    */

481
    /* input variable "audio-delay" and "sub-delay" */
482 483 484 485 486 487
    INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
    INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
    INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
    INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */

    /* Meta datas */
488 489 490 491
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
    INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
    INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
    INPUT_SET_NAME,   /* arg1= char* res=can fail    */
492

493 494 495 496
    /* Input config options */
    INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/

    /* Input properties */
497
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
498

Laurent Aimar's avatar
Laurent Aimar committed
499
    /* bookmarks */
500
    INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
501 502 503 504 505 506
    INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
    INPUT_CLEAR_BOOKMARKS, /* res=can fail */
    INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
    INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
507

508 509 510 511
    /* Attachments */
    INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
    INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */

512
    /* On the fly input slave */
513 514
    INPUT_ADD_SLAVE,       /* arg1= const char * */
    INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
515 516 517 518

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
519 520 521

    /* ES */
    INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
522 523 524 525 526

    /* Input ressources
     * XXX You must call vlc_object_release as soon as possible */
    INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
    INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, int *        res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
527 528 529 530 531
};

VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );

532 533 534 535
/**
 * It will return the current state of the input.
 * Provided for convenience.
 */
536 537 538 539 540 541
static inline input_state_e input_GetState( input_thread_t * p_input )
{
    input_state_e state = INIT_S;
    input_Control( p_input, INPUT_GET_STATE, &state );
    return state;
}
542 543 544 545 546 547 548 549
/**
 * It will add a new subtitle source to the input.
 * Provided for convenience.
 */
static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
{
    return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
}
550

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
/**
 * Return one of the video output (if any). If possible, you should use
 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 * @param p_input an input thread from which to get a video output
 * @return NULL on error, or a video output thread pointer (which needs to be
 * released with vlc_object_release()).
 */
static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
{
     vout_thread_t **pp_vout, *p_vout;
     unsigned i_vout;

     if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
         return NULL;

     for( unsigned i = 1; i < i_vout; i++ )
         vlc_object_release( (vlc_object_t *)(pp_vout[i]) );

     p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
     free (pp_vout);
     return p_vout;
}

/**
 * Return the audio output (if any) associated with an input.
 * @param p_input an input thread
 * @return NULL on error, or the audio output (which needs to be
 * released with vlc_object_release()).
 */
static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
{
     aout_instance_t *p_aout;
583
     return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
584 585
}

586
/* */
587 588
typedef struct input_clock_t input_clock_t;
VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
Laurent Aimar's avatar
Laurent Aimar committed
589 590 591
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );

Laurent Aimar's avatar
Laurent Aimar committed
592 593 594 595 596 597 598 599 600
/**
 * This function allows to split a MRL into access, demux and path part.
 *
 *  You should not write into access and demux string as they may not point into
 * the provided buffer.
 *  The buffer provided by psz_dup will be modified.
 */
VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );

601 602 603 604 605
/**
 * This function creates a sane filename path.
 */
VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );

Laurent Aimar's avatar
Laurent Aimar committed
606
#endif