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

   1 /*****************************************************************************
   2  * vlc_sout.h : stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2008 VLC authors and VideoLAN
   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  *          Rémi Denis-Courmont
  12  *
  13  * This program is free software; you can redistribute it and/or modify it
  14  * under the terms of the GNU Lesser General Public License as published by
  15  * the Free Software Foundation; either version 2.1 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU Lesser General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public License
  24  * along with this program; if not, write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  26  *****************************************************************************/
  27
  28 #ifndef VLC_SOUT_H_
  29 #define VLC_SOUT_H_
  30
  31 /**
  32  * \file
  33  * This file defines structures and functions for stream output in vlc
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include <sys/types.h>
  41 #include <vlc_es.h>
  42
  43 /** Stream output instance */
  44 struct sout_instance_t
  45 {
  46     VLC_COMMON_MEMBERS
  47
  48     char *psz_sout;
  49
  50     /** count of output that can't control the space */
  51     int                 i_out_pace_nocontrol;
  52
  53     vlc_mutex_t         lock;
  54     sout_stream_t       *p_stream;
  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     char                    *psz_access;
  69
  70     char                    *psz_path;
  71     sout_access_out_sys_t   *p_sys;
  72     int                     (*pf_seek)( sout_access_out_t *, off_t );
  73     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
  74     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
  75     int                     (*pf_control)( sout_access_out_t *, int, va_list );
  76
  77     config_chain_t          *p_cfg;
  78 };
  79
  80 enum access_out_query_e
  81 {
  82     ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
  83 };
  84
  85 VLC_API sout_access_out_t * sout_AccessOutNew( vlc_object_t *, const char *psz_access, const char *psz_name ) VLC_USED;
  86 #define sout_AccessOutNew( obj, access, name ) \
  87         sout_AccessOutNew( VLC_OBJECT(obj), access, name )
  88 VLC_API void sout_AccessOutDelete( sout_access_out_t * );
  89 VLC_API int sout_AccessOutSeek( sout_access_out_t *, off_t );
  90 VLC_API ssize_t sout_AccessOutRead( sout_access_out_t *, block_t * );
  91 VLC_API ssize_t sout_AccessOutWrite( sout_access_out_t *, block_t * );
  92 VLC_API int sout_AccessOutControl( sout_access_out_t *, int, ... );
  93
  94 static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
  95 {
  96     bool b;
  97     if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
  98         return true;
  99     return b;
 100 }
 101
 102 /** Muxer structure */
 103 struct  sout_mux_t
 104 {
 105     VLC_COMMON_MEMBERS
 106     module_t            *p_module;
 107
 108     sout_instance_t     *p_sout;
 109
 110     char                *psz_mux;
 111     config_chain_t          *p_cfg;
 112
 113     sout_access_out_t   *p_access;
 114
 115     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 116     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
 117     int                 (*pf_mux)      ( sout_mux_t * );
 118     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 119
 120     /* here are all inputs accepted by muxer */
 121     int                 i_nb_inputs;
 122     sout_input_t        **pp_inputs;
 123
 124     /* mux private */
 125     sout_mux_sys_t      *p_sys;
 126
 127     /* XXX private to stream_output.c */
 128     /* if muxer doesn't support adding stream at any time then we first wait
 129      *  for stream then we refuse all stream and start muxing */
 130     bool  b_add_stream_any_time;
 131     bool  b_waiting_stream;
 132     /* we wait one second after first stream added */
 133     mtime_t     i_add_stream_start;
 134 };
 135
 136 enum sout_mux_query_e
 137 {
 138     /* capabilities */
 139     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
 140     /* properties */
 141     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
 142     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 143 };
 144
 145 struct sout_input_t
 146 {
 147     es_format_t     *p_fmt;
 148     block_fifo_t    *p_fifo;
 149
 150     void            *p_sys;
 151 };
 152
 153
 154 VLC_API sout_mux_t * sout_MuxNew( sout_instance_t*, const char *, sout_access_out_t * ) VLC_USED;
 155 VLC_API sout_input_t * sout_MuxAddStream( sout_mux_t *, es_format_t * ) VLC_USED;
 156 VLC_API void sout_MuxDeleteStream( sout_mux_t *, sout_input_t * );
 157 VLC_API void sout_MuxDelete( sout_mux_t * );
 158 VLC_API void sout_MuxSendBuffer( sout_mux_t *, sout_input_t  *, block_t * );
 159 VLC_API int sout_MuxGetStream(sout_mux_t *, int , mtime_t *);
 160
 161 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 162 {
 163     va_list args;
 164     int     i_result;
 165
 166     va_start( args, i_query );
 167     i_result = p_mux->pf_control( p_mux, i_query, args );
 168     va_end( args );
 169     return i_result;
 170 }
 171
 172 /****************************************************************************
 173  * sout_stream:
 174  ****************************************************************************/
 175 struct sout_stream_t
 176 {
 177     VLC_COMMON_MEMBERS
 178
 179     module_t          *p_module;
 180     sout_instance_t   *p_sout;
 181
 182     char              *psz_name;
 183     config_chain_t        *p_cfg;
 184     sout_stream_t     *p_next;
 185
 186     /* add, remove a stream */
 187     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
 188     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
 189     /* manage a packet */
 190     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
 191
 192     /* private */
 193     sout_stream_sys_t *p_sys;
 194 };
 195
 196 VLC_API void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last );
 197 VLC_API sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout,
 198         char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) VLC_USED;
 199
 200 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 201 {
 202     return s->pf_add( s, fmt );
 203 }
 204 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
 205 {
 206     return s->pf_del( s, id );
 207 }
 208 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
 209 {
 210     return s->pf_send( s, id, b );
 211 }
 212
 213 /****************************************************************************
 214  * Encoder
 215  ****************************************************************************/
 216
 217 VLC_API encoder_t * sout_EncoderCreate( vlc_object_t *obj );
 218 #define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
 219
 220 /****************************************************************************
 221  * Announce handler
 222  ****************************************************************************/
 223 VLC_API session_descriptor_t* sout_AnnounceRegisterSDP( vlc_object_t *, const char *, const char * ) VLC_USED;
 224 VLC_API int sout_AnnounceUnRegister(vlc_object_t *,session_descriptor_t* );
 225 #define sout_AnnounceRegisterSDP(o, sdp, addr) \
 226         sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr)
 227 #define sout_AnnounceUnRegister(o, a) \
 228         sout_AnnounceUnRegister(VLC_OBJECT (o), a)
 229
 230 /** SDP */
 231
 232 struct sockaddr;
 233
 234 VLC_API char * vlc_sdp_Start( vlc_object_t *obj, const char *cfgpref, const struct sockaddr *src, size_t srclen, const struct sockaddr *addr, size_t addrlen ) VLC_USED;
 235 VLC_API char * sdp_AddMedia(char **sdp, const char *type, const char *protocol, int dport, unsigned pt, bool bw_indep, unsigned bw, const char *ptname, unsigned clockrate, unsigned channels, const char *fmtp);
 236 VLC_API char * sdp_AddAttribute(char **sdp, const char *name, const char *fmt, ...) VLC_FORMAT( 3, 4 );
 237
 238 /** Description module */
 239 typedef struct sout_description_data_t
 240 {
 241     int i_es;
 242     es_format_t **es;
 243     vlc_sem_t *sem;
 244 } sout_description_data_t;
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif
 249
 250 #endif