vlc_es_out.h 5.33 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 39 40
/**
 * \defgroup es out Es Out
 * @{
 */

enum es_out_mode_e
{
    ES_OUT_MODE_NONE,   /* don't select anything */
    ES_OUT_MODE_ALL,    /* eg for stream output */
41
    ES_OUT_MODE_AUTO,   /* best audio/video or for input follow audio-track, sub-track */
42
    ES_OUT_MODE_PARTIAL /* select programs given after --programs */
Laurent Aimar's avatar
Laurent Aimar committed
43 44 45 46
};

enum es_out_query_e
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
47
    /* activate application of mode */
48
    ES_OUT_SET_ACTIVE,  /* arg1= bool                     */
Laurent Aimar's avatar
Laurent Aimar committed
49
    /* see if mode is currently aplied or not */
50
    ES_OUT_GET_ACTIVE,  /* arg1= bool*                    */
Laurent Aimar's avatar
Laurent Aimar committed
51 52 53 54 55

    /* set/get mode */
    ES_OUT_SET_MODE,    /* arg1= int                            */
    ES_OUT_GET_MODE,    /* arg2= int*                           */

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
56
    /* set ES selected for the es category (audio/video/spu) */
Laurent Aimar's avatar
Laurent Aimar committed
57
    ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
58
    ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
Laurent Aimar's avatar
Laurent Aimar committed
59

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
63
    /* force selection/unselection of the ES (bypass current mode) */
64 65
    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
66 67 68 69 70

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
71 72
    /* 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
73
     * to slow down the demuxer so that it reads at the right speed.
74
     * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
75
     * as you would normally do.
Laurent Aimar's avatar
Laurent Aimar committed
76
     */
Laurent Aimar's avatar
Laurent Aimar committed
77 78 79
    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 */
80

81 82 83 84
    /* Timestamp handling, convert an input timestamp to a global clock one.
     * (shouldn't have to be used by input plugins directly) */
    ES_OUT_GET_TS,             /* arg1=int64_t i_ts(microsecond!) (using default group 0), arg2=int64_t* converted i_ts */

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

88 89
    /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
    ES_OUT_SET_NEXT_DISPLAY_TIME,   /* arg1=int64_t i_pts(microsecond) */
90 91
    /* Set meta data for group (dynamic) */
    ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=vlc_meta_t */
92 93
    /* Set epg for group (dynamic) */
    ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=vlc_epg_t */
94
    /* */
95 96 97 98
    ES_OUT_DEL_GROUP,       /* arg1=int i_group */

    /* First value usable for private control */
    ES_OUT_PRIVATE_START = 0x10000,
Laurent Aimar's avatar
Laurent Aimar committed
99 100 101 102
};

struct es_out_t
{
103
    es_out_id_t *(*pf_add)    ( es_out_t *, const es_format_t * );
Laurent Aimar's avatar
Laurent Aimar committed
104 105 106
    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 );
107 108 109
    void         (*pf_destroy)( es_out_t * );

    bool         b_sout;
Laurent Aimar's avatar
Laurent Aimar committed
110 111 112 113

    es_out_sys_t    *p_sys;
};

114
LIBVLC_USED
115
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
116 117 118
{
    return out->pf_add( out, fmt );
}
119

Laurent Aimar's avatar
Laurent Aimar committed
120 121 122 123
static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
{
    out->pf_del( out, id );
}
124

Laurent Aimar's avatar
Laurent Aimar committed
125 126 127 128 129 130 131 132 133 134
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 );
}
135

Laurent Aimar's avatar
Laurent Aimar committed
136 137 138 139 140 141 142 143 144 145 146
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;
}

147 148 149 150 151
static inline void es_out_Delete( es_out_t *p_out )
{
    p_out->pf_destroy( p_out );
}

Laurent Aimar's avatar
Laurent Aimar committed
152 153 154 155 156
/**
 * @}
 */

#endif