vlc_es_out.h 4.95 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
2
 * vlc_es_out.h: es_out (demuxer output) descriptor, queries and methods
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
4
 * Copyright (C) 1999-2004 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
 *
 * Authors: 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
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Laurent Aimar's avatar
Laurent Aimar committed
22 23
 *****************************************************************************/

24 25
#ifndef VLC_ES_OUT_H
#define VLC_ES_OUT_H 1
Laurent Aimar's avatar
Laurent Aimar committed
26

27 28 29 30 31
/**
 * \file
 * This file defines functions and structures for handling es_out in stream output
 */

Laurent Aimar's avatar
Laurent Aimar committed
32 33 34 35 36 37 38
/**
 * \defgroup es out Es Out
 * @{
 */

enum es_out_query_e
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
39
    /* set ES selected for the es category (audio/video/spu) */
Laurent Aimar's avatar
Laurent Aimar committed
40
    ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
41
    ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
Laurent Aimar's avatar
Laurent Aimar committed
42

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
43
    /* set 'default' tag on ES (copied across from container) */
44
    ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t*                */
45

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
46
    /* force selection/unselection of the ES (bypass current mode) */
47 48
    ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
    ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
Laurent Aimar's avatar
Laurent Aimar committed
49 50 51 52

    /* */
    ES_OUT_SET_GROUP,   /* arg1= int                            */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
53 54
    /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
     * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
55
     * to slow down the demuxer so that it reads at the right speed.
56
     * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
57
     * as you would normally do.
Laurent Aimar's avatar
Laurent Aimar committed
58
     */
Laurent Aimar's avatar
Laurent Aimar committed
59 60 61
    ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
    ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
    ES_OUT_RESET_PCR,           /* no arg */
62 63

    /* Try not to use this one as it is a bit hacky */
Laurent Aimar's avatar
Laurent Aimar committed
64
    ES_OUT_SET_ES_FMT,         /* arg1= es_out_id_t* arg2=es_format_t* */
Laurent Aimar's avatar
Laurent Aimar committed
65

66
    /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
67
    ES_OUT_SET_NEXT_DISPLAY_TIME,       /* arg1=int64_t i_pts(microsecond) */
68 69 70 71
    /* Set meta data for group (dynamic) (The vlc_meta_t is not modified nor released) */
    ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=const vlc_meta_t */
    /* Set epg for group (dynamic) (The vlc_epg_t is not modified nor released) */
    ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=const vlc_epg_t */
72
    /* */
73 74
    ES_OUT_DEL_GROUP,       /* arg1=int i_group */

75 76 77
    /* Set scrambled state for one es */
    ES_OUT_SET_ES_SCRAMBLED_STATE,  /* arg1=int i_group arg2=es_out_id_t* */

78 79 80 81 82 83 84
    /* Stop any buffering being done, and ask if es_out has no more data to
     * play.
     * It will not block and so MUST be used carrefully. The only good reason
     * is for interactive playback (like for DVD menu).
     * XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
    ES_OUT_GET_EMPTY,       /* arg1=bool*   res=cannot fail */

85 86
    /* First value usable for private control */
    ES_OUT_PRIVATE_START = 0x10000,
Laurent Aimar's avatar
Laurent Aimar committed
87 88 89 90
};

struct es_out_t
{
91
    es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
92 93 94
    int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
    void         (*pf_del)    ( es_out_t *, es_out_id_t * );
    int          (*pf_control)( es_out_t *, int i_query, va_list );
95 96 97
    void         (*pf_destroy)( es_out_t * );

    bool         b_sout;
Laurent Aimar's avatar
Laurent Aimar committed
98 99 100 101

    es_out_sys_t    *p_sys;
};

102
LIBVLC_USED
103
static inline es_out_id_t * es_out_Add( es_out_t *out, const es_format_t *fmt )
Laurent Aimar's avatar
Laurent Aimar committed
104 105 106
{
    return out->pf_add( out, fmt );
}
107

Laurent Aimar's avatar
Laurent Aimar committed
108 109 110 111
static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
{
    out->pf_del( out, id );
}
112

Laurent Aimar's avatar
Laurent Aimar committed
113 114 115 116 117 118 119 120 121 122
static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
                               block_t *p_block )
{
    return out->pf_send( out, id, p_block );
}

static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
{
    return out->pf_control( out, i_query, args );
}
123

Laurent Aimar's avatar
Laurent Aimar committed
124 125 126 127 128 129 130 131 132 133 134
static inline int es_out_Control( es_out_t *out, int i_query, ... )
{
    va_list args;
    int     i_result;

    va_start( args, i_query );
    i_result = es_out_vaControl( out, i_query, args );
    va_end( args );
    return i_result;
}

135 136 137 138 139
static inline void es_out_Delete( es_out_t *p_out )
{
    p_out->pf_destroy( p_out );
}

Laurent Aimar's avatar
Laurent Aimar committed
140 141 142 143 144
/**
 * @}
 */

#endif