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 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 #include <sys/types.h>
  36 #include <vlc_es.h>
  37
  38 /**
  39  * \defgroup sout Stream output
  40  * \ingroup output
  41  * @{
  42  * \file
  43  * Stream output modules interface
  44  */
  45
  46 /** Stream output instance (FIXME: should be private to src/ to avoid
  47  * invalid unsynchronized access) */
  48 struct sout_instance_t
  49 {
  50     VLC_COMMON_MEMBERS
  51
  52     char *psz_sout;
  53
  54     /** count of output that can't control the space */
  55     int                 i_out_pace_nocontrol;
  56
  57     vlc_mutex_t         lock;
  58     sout_stream_t       *p_stream;
  59 };
  60
  61 /****************************************************************************
  62  * sout_stream_id_sys_t: opaque (private for all sout_stream_t)
  63  ****************************************************************************/
  64 typedef struct sout_stream_id_sys_t  sout_stream_id_sys_t;
  65
  66 /**
  67  * \defgroup sout_access Access output
  68  * Raw output byte streams
  69  * @{
  70  */
  71
  72 /** Stream output access_output */
  73 struct sout_access_out_t
  74 {
  75     VLC_COMMON_MEMBERS
  76
  77     module_t                *p_module;
  78     char                    *psz_access;
  79
  80     char                    *psz_path;
  81     sout_access_out_sys_t   *p_sys;
  82     int                     (*pf_seek)( sout_access_out_t *, off_t );
  83     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
  84     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
  85     int                     (*pf_control)( sout_access_out_t *, int, va_list );
  86
  87     config_chain_t          *p_cfg;
  88 };
  89
  90 enum access_out_query_e
  91 {
  92     ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
  93     ACCESS_OUT_CAN_SEEK, /* arg1=bool *, can fail (assume false) */
  94 };
  95
  96 VLC_API sout_access_out_t * sout_AccessOutNew( vlc_object_t *, const char *psz_access, const char *psz_name ) VLC_USED;
  97 #define sout_AccessOutNew( obj, access, name ) \
  98         sout_AccessOutNew( VLC_OBJECT(obj), access, name )
  99 VLC_API void sout_AccessOutDelete( sout_access_out_t * );
 100 VLC_API int sout_AccessOutSeek( sout_access_out_t *, off_t );
 101 VLC_API ssize_t sout_AccessOutRead( sout_access_out_t *, block_t * );
 102 VLC_API ssize_t sout_AccessOutWrite( sout_access_out_t *, block_t * );
 103 VLC_API int sout_AccessOutControl( sout_access_out_t *, int, ... );
 104
 105 static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
 106 {
 107     bool b;
 108     if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
 109         return true;
 110     return b;
 111 }
 112
 113 /**
 114  * @}
 115  * \defgroup sout_mux Multiplexer
 116  * Multiplexers (file formatters)
 117  * @{
 118  */
 119
 120 /** Muxer structure */
 121 struct  sout_mux_t
 122 {
 123     VLC_COMMON_MEMBERS
 124     module_t            *p_module;
 125
 126     sout_instance_t     *p_sout;
 127
 128     char                *psz_mux;
 129     config_chain_t          *p_cfg;
 130
 131     sout_access_out_t   *p_access;
 132
 133     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 134     void                (*pf_delstream)( sout_mux_t *, sout_input_t * );
 135     int                 (*pf_mux)      ( sout_mux_t * );
 136     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 137
 138     /* here are all inputs accepted by muxer */
 139     int                 i_nb_inputs;
 140     sout_input_t        **pp_inputs;
 141
 142     /* mux private */
 143     sout_mux_sys_t      *p_sys;
 144
 145     /* XXX private to stream_output.c */
 146     /* if muxer doesn't support adding stream at any time then we first wait
 147      *  for stream then we refuse all stream and start muxing */
 148     bool  b_add_stream_any_time;
 149     bool  b_waiting_stream;
 150     /* we wait 1.5 second after first stream added */
 151     mtime_t     i_add_stream_start;
 152 };
 153
 154 enum sout_mux_query_e
 155 {
 156     /* capabilities */
 157     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
 158     /* properties */
 159     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
 160     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 161 };
 162
 163 struct sout_input_t
 164 {
 165     const es_format_t *p_fmt;
 166     block_fifo_t      *p_fifo;
 167     void              *p_sys;
 168     es_format_t        fmt;
 169 };
 170
 171
 172 VLC_API sout_mux_t * sout_MuxNew( sout_instance_t*, const char *, sout_access_out_t * ) VLC_USED;
 173 VLC_API sout_input_t *sout_MuxAddStream( sout_mux_t *, const es_format_t * ) VLC_USED;
 174 VLC_API void sout_MuxDeleteStream( sout_mux_t *, sout_input_t * );
 175 VLC_API void sout_MuxDelete( sout_mux_t * );
 176 VLC_API int sout_MuxSendBuffer( sout_mux_t *, sout_input_t  *, block_t * );
 177 VLC_API int sout_MuxGetStream(sout_mux_t *, unsigned, mtime_t *);
 178 VLC_API void sout_MuxFlush( sout_mux_t *, sout_input_t * );
 179
 180 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 181 {
 182     va_list args;
 183     int     i_result;
 184
 185     va_start( args, i_query );
 186     i_result = p_mux->pf_control( p_mux, i_query, args );
 187     va_end( args );
 188     return i_result;
 189 }
 190
 191 /** @} */
 192
 193 enum sout_stream_query_e {
 194     SOUT_STREAM_EMPTY,    /* arg1=bool *,       res=can fail (assume true) */
 195 };
 196
 197 struct sout_stream_t
 198 {
 199     VLC_COMMON_MEMBERS
 200
 201     module_t          *p_module;
 202     sout_instance_t   *p_sout;
 203
 204     char              *psz_name;
 205     config_chain_t    *p_cfg;
 206     sout_stream_t     *p_next;
 207
 208     /* add, remove a stream */
 209     sout_stream_id_sys_t *(*pf_add)( sout_stream_t *, const es_format_t * );
 210     void              (*pf_del)( sout_stream_t *, sout_stream_id_sys_t * );
 211     /* manage a packet */
 212     int               (*pf_send)( sout_stream_t *, sout_stream_id_sys_t *, block_t* );
 213     int               (*pf_control)( sout_stream_t *, int, va_list );
 214     void              (*pf_flush)( sout_stream_t *, sout_stream_id_sys_t * );
 215
 216     sout_stream_sys_t *p_sys;
 217     bool pace_nocontrol;
 218 };
 219
 220 VLC_API void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last );
 221 VLC_API sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout,
 222         const char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) VLC_USED;
 223
 224 static inline sout_stream_id_sys_t *sout_StreamIdAdd( sout_stream_t *s,
 225                                                       const es_format_t *fmt )
 226 {
 227     return s->pf_add( s, fmt );
 228 }
 229
 230 static inline void sout_StreamIdDel( sout_stream_t *s,
 231                                      sout_stream_id_sys_t *id )
 232 {
 233     s->pf_del( s, id );
 234 }
 235
 236 static inline int sout_StreamIdSend( sout_stream_t *s,
 237                                      sout_stream_id_sys_t *id, block_t *b )
 238 {
 239     return s->pf_send( s, id, b );
 240 }
 241
 242 static inline void sout_StreamFlush( sout_stream_t *s,
 243                                      sout_stream_id_sys_t *id )
 244 {
 245     if (s->pf_flush)
 246         s->pf_flush( s, id );
 247 }
 248
 249 static inline int sout_StreamControl( sout_stream_t *s, int i_query, ... )
 250 {
 251     va_list args;
 252     int     i_result;
 253
 254     va_start( args, i_query );
 255     if ( !s->pf_control )
 256         i_result = VLC_EGENERIC;
 257     else
 258         i_result = s->pf_control( s, i_query, args );
 259     va_end( args );
 260     return i_result;
 261 }
 262
 263 /****************************************************************************
 264  * Encoder
 265  ****************************************************************************/
 266
 267 VLC_API encoder_t * sout_EncoderCreate( vlc_object_t *obj );
 268 #define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
 269
 270 /****************************************************************************
 271  * Announce handler
 272  ****************************************************************************/
 273 VLC_API session_descriptor_t* sout_AnnounceRegisterSDP( vlc_object_t *, const char *, const char * ) VLC_USED;
 274 VLC_API void sout_AnnounceUnRegister(vlc_object_t *,session_descriptor_t* );
 275 #define sout_AnnounceRegisterSDP(o, sdp, addr) \
 276         sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr)
 277 #define sout_AnnounceUnRegister(o, a) \
 278         sout_AnnounceUnRegister(VLC_OBJECT (o), a)
 279
 280 /** SDP */
 281
 282 struct sockaddr;
 283
 284 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;
 285 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);
 286 VLC_API char * sdp_AddAttribute(char **sdp, const char *name, const char *fmt, ...) VLC_FORMAT( 3, 4 );
 287
 288 /** Description module */
 289 typedef struct sout_description_data_t
 290 {
 291     int i_es;
 292     es_format_t **es;
 293     vlc_sem_t *sem;
 294 } sout_description_data_t;
 295
 296 /** @} */
 297
 298 #ifdef __cplusplus
 299 }
 300 #endif
 301
 302 #endif