git.sesse.net Git - vlc/blob - include/vlc_sout.h

   1 /*****************************************************************************
   2  * stream_output.h : stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *          Eric Petit <titer@videolan.org>
  10  *          Jean-Paul Saman <jpsaman #_at_# m2x.nl>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef _VLC_SOUT_H_
  28 #define _VLC_SOUT_H_
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <vlc_es.h>
  35
  36 /** Stream output instance */
  37 struct sout_instance_t
  38 {
  39     VLC_COMMON_MEMBERS
  40
  41     char *psz_sout;
  42     char *psz_chain;
  43
  44     /* meta data (Read only) XXX it won't be set before the first packet received */
  45     vlc_meta_t          *p_meta;
  46
  47     /** count of output that can't control the space */
  48     int                 i_out_pace_nocontrol;
  49
  50     vlc_mutex_t         lock;
  51     sout_stream_t       *p_stream;
  52
  53     /** Private */
  54     sout_instance_sys_t *p_sys;
  55 };
  56
  57 /****************************************************************************
  58  * sout_stream_id_t: opaque (private for all sout_stream_t)
  59  ****************************************************************************/
  60 typedef struct sout_stream_id_t  sout_stream_id_t;
  61
  62 /** Stream output access_output */
  63 struct sout_access_out_t
  64 {
  65     VLC_COMMON_MEMBERS
  66
  67     module_t                *p_module;
  68
  69     sout_instance_t         *p_sout;
  70
  71     char                    *psz_access;
  72     config_chain_t              *p_cfg;
  73
  74     int                      i_writes;
  75     /** Local counter reset each time it is transferred to stats */
  76     int64_t                  i_sent_bytes;
  77
  78     char                    *psz_name;
  79     sout_access_out_sys_t   *p_sys;
  80     int                     (*pf_seek)( sout_access_out_t *, off_t );
  81     int                     (*pf_read)( sout_access_out_t *, block_t * );
  82     int                     (*pf_write)( sout_access_out_t *, block_t * );
  83 };
  84
  85 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
  86 VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
  87 VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
  88 VLC_EXPORT( int,                sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
  89 VLC_EXPORT( int,                sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
  90
  91 /** Muxer structure */
  92 struct  sout_mux_t
  93 {
  94     VLC_COMMON_MEMBERS
  95     module_t            *p_module;
  96
  97     sout_instance_t     *p_sout;
  98
  99     char                *psz_mux;
 100     config_chain_t          *p_cfg;
 101
 102     sout_access_out_t   *p_access;
 103
 104     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 105     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
 106     int                 (*pf_mux)      ( sout_mux_t * );
 107     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 108
 109     /* here are all inputs accepted by muxer */
 110     int                 i_nb_inputs;
 111     sout_input_t        **pp_inputs;
 112
 113     /* mux private */
 114     sout_mux_sys_t      *p_sys;
 115
 116     /* XXX private to stream_output.c */
 117     /* if muxer doesn't support adding stream at any time then we first wait
 118      *  for stream then we refuse all stream and start muxing */
 119     vlc_bool_t  b_add_stream_any_time;
 120     vlc_bool_t  b_waiting_stream;
 121     /* we wait one second after first stream added */
 122     mtime_t     i_add_stream_start;
 123 };
 124
 125 enum sout_mux_query_e
 126 {
 127     /* capabilities */
 128     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= vlc_bool_t *,      res=cannot fail */
 129     /* properties */
 130     MUX_GET_ADD_STREAM_WAIT,            /* arg1= vlc_bool_t *,      res=cannot fail */
 131     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 132 };
 133
 134 struct sout_input_t
 135 {
 136     sout_instance_t *p_sout;
 137
 138     es_format_t     *p_fmt;
 139     block_fifo_t    *p_fifo;
 140
 141     void            *p_sys;
 142 };
 143
 144
 145 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
 146 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
 147 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
 148 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
 149 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
 150
 151 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 152 {
 153     va_list args;
 154     int     i_result;
 155
 156     va_start( args, i_query );
 157     i_result = p_mux->pf_control( p_mux, i_query, args );
 158     va_end( args );
 159     return i_result;
 160 }
 161
 162 /****************************************************************************
 163  * sout_stream:
 164  ****************************************************************************/
 165 struct sout_stream_t
 166 {
 167     VLC_COMMON_MEMBERS
 168
 169     module_t          *p_module;
 170     sout_instance_t   *p_sout;
 171
 172     char              *psz_name;
 173     config_chain_t        *p_cfg;
 174     char              *psz_next;
 175
 176     /* Subpicture unit */
 177     spu_t             *p_spu;
 178
 179     /* add, remove a stream */
 180     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
 181     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
 182     /* manage a packet */
 183     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
 184
 185     /* private */
 186     sout_stream_sys_t *p_sys;
 187 };
 188
 189 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
 190 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
 191
 192 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 193 {
 194     return s->pf_add( s, fmt );
 195 }
 196 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
 197 {
 198     return s->pf_del( s, id );
 199 }
 200 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
 201 {
 202     return s->pf_send( s, id, b );
 203 }
 204
 205 /****************************************************************************
 206  * Announce handler mess
 207  ****************************************************************************/
 208 struct sap_session_t;
 209
 210 struct session_descriptor_t
 211 {
 212     char *psz_name;
 213     char *psz_uri;
 214     int i_port;
 215     int i_ttl;
 216     int i_payload;   /* SAP Payload type */
 217
 218     char *psz_group;
 219
 220     sap_session_t *p_sap; /* If we have a sap session, remember it */
 221     char *psz_sdp;
 222     vlc_bool_t b_rtp;
 223 };
 224
 225 #define METHOD_TYPE_SAP 1
 226
 227 struct announce_method_t
 228 {
 229     int i_type;
 230 };
 231
 232 VLC_EXPORT( int,                sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
 233 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *,const char *, const char *, announce_method_t* ) );
 234 VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
 235
 236 VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (void) );
 237 VLC_EXPORT(void,                 sout_AnnounceSessionDestroy, (session_descriptor_t *) );
 238 VLC_EXPORT(announce_method_t*,   sout_AnnounceMethodCreate, (int) );
 239
 240 #ifdef __cplusplus
 241 }
 242 #endif
 243
 244 #endif