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     struct vlc_common_members obj;
  51
  52     char *psz_sout;
  53
  54     /** count of output that can't control the space */
  55     int                 i_out_pace_nocontrol;
  56     bool                b_wants_substreams;
  57
  58     vlc_mutex_t         lock;
  59     sout_stream_t       *p_stream;
  60 };
  61
  62 /**
  63  * \defgroup sout_access Access output
  64  * Raw output byte streams
  65  * @{
  66  */
  67
  68 /** Stream output access_output */
  69 struct sout_access_out_t
  70 {
  71     struct vlc_common_members obj;
  72
  73     module_t                *p_module;
  74     char                    *psz_access;
  75
  76     char                    *psz_path;
  77     void                    *p_sys;
  78     int                     (*pf_seek)( sout_access_out_t *, off_t );
  79     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
  80     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
  81     int                     (*pf_control)( sout_access_out_t *, int, va_list );
  82
  83     config_chain_t          *p_cfg;
  84 };
  85
  86 enum access_out_query_e
  87 {
  88     ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
  89     ACCESS_OUT_CAN_SEEK, /* arg1=bool *, can fail (assume false) */
  90 };
  91
  92 VLC_API sout_access_out_t * sout_AccessOutNew( vlc_object_t *, const char *psz_access, const char *psz_name ) VLC_USED;
  93 #define sout_AccessOutNew( obj, access, name ) \
  94         sout_AccessOutNew( VLC_OBJECT(obj), access, name )
  95 VLC_API void sout_AccessOutDelete( sout_access_out_t * );
  96 VLC_API int sout_AccessOutSeek( sout_access_out_t *, off_t );
  97 VLC_API ssize_t sout_AccessOutRead( sout_access_out_t *, block_t * );
  98 VLC_API ssize_t sout_AccessOutWrite( sout_access_out_t *, block_t * );
  99 VLC_API int sout_AccessOutControl( sout_access_out_t *, int, ... );
 100
 101 static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
 102 {
 103     bool b;
 104     if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
 105         return true;
 106     return b;
 107 }
 108
 109 /**
 110  * @}
 111  * \defgroup sout_mux Multiplexer
 112  * Multiplexers (file formatters)
 113  * @{
 114  */
 115
 116 /** Muxer structure */
 117 struct  sout_mux_t
 118 {
 119     struct vlc_common_members obj;
 120     module_t            *p_module;
 121
 122     sout_instance_t     *p_sout;
 123
 124     char                *psz_mux;
 125     config_chain_t          *p_cfg;
 126
 127     sout_access_out_t   *p_access;
 128
 129     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 130     void                (*pf_delstream)( sout_mux_t *, sout_input_t * );
 131     int                 (*pf_mux)      ( sout_mux_t * );
 132     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 133
 134     /* here are all inputs accepted by muxer */
 135     int                 i_nb_inputs;
 136     sout_input_t        **pp_inputs;
 137
 138     /* mux private */
 139     void                *p_sys;
 140
 141     /* XXX private to stream_output.c */
 142     /* if muxer doesn't support adding stream at any time then we first wait
 143      *  for stream then we refuse all stream and start muxing */
 144     bool  b_add_stream_any_time;
 145     bool  b_waiting_stream;
 146     /* we wait 1.5 second after first stream added */
 147     vlc_tick_t  i_add_stream_start;
 148 };
 149
 150 enum sout_mux_query_e
 151 {
 152     /* capabilities */
 153     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
 154     /* properties */
 155     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
 156     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 157 };
 158
 159 struct sout_input_t
 160 {
 161     const es_format_t *p_fmt;
 162     block_fifo_t      *p_fifo;
 163     void              *p_sys;
 164     es_format_t        fmt;
 165 };
 166
 167
 168 VLC_API sout_mux_t * sout_MuxNew( sout_instance_t*, const char *, sout_access_out_t * ) VLC_USED;
 169 VLC_API sout_input_t *sout_MuxAddStream( sout_mux_t *, const es_format_t * ) VLC_USED;
 170 VLC_API void sout_MuxDeleteStream( sout_mux_t *, sout_input_t * );
 171 VLC_API void sout_MuxDelete( sout_mux_t * );
 172 VLC_API int sout_MuxSendBuffer( sout_mux_t *, sout_input_t  *, block_t * );
 173 VLC_API int sout_MuxGetStream(sout_mux_t *, unsigned, vlc_tick_t *);
 174 VLC_API void sout_MuxFlush( sout_mux_t *, sout_input_t * );
 175
 176 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 177 {
 178     va_list args;
 179     int     i_result;
 180
 181     va_start( args, i_query );
 182     i_result = p_mux->pf_control( p_mux, i_query, args );
 183     va_end( args );
 184     return i_result;
 185 }
 186
 187 /** @} */
 188
 189 enum sout_stream_query_e {
 190     SOUT_STREAM_EMPTY,    /* arg1=bool *,       res=can fail (assume true) */
 191     SOUT_STREAM_WANTS_SUBSTREAMS,  /* arg1=bool *, res=can fail (assume false) */
 192     SOUT_STREAM_ID_SPU_HIGHLIGHT,  /* arg1=void *, arg2=const vlc_spu_highlight_t *, res=can fail */
 193 };
 194
 195 struct sout_stream_t
 196 {
 197     struct vlc_common_members obj;
 198
 199     module_t          *p_module;
 200     sout_instance_t   *p_sout;
 201
 202     char              *psz_name;
 203     config_chain_t    *p_cfg;
 204     sout_stream_t     *p_next;
 205
 206     /* add, remove a stream */
 207     void             *(*pf_add)( sout_stream_t *, const es_format_t * );
 208     void              (*pf_del)( sout_stream_t *, void * );
 209     /* manage a packet */
 210     int               (*pf_send)( sout_stream_t *, void *, block_t* );
 211     int               (*pf_control)( sout_stream_t *, int, va_list );
 212     void              (*pf_flush)( sout_stream_t *, void * );
 213
 214     void              *p_sys;
 215     bool pace_nocontrol;
 216 };
 217
 218 VLC_API void sout_StreamChainDelete(sout_stream_t *p_first, sout_stream_t *p_last );
 219 VLC_API sout_stream_t *sout_StreamChainNew(sout_instance_t *p_sout,
 220         const char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) VLC_USED;
 221
 222 static inline void *sout_StreamIdAdd( sout_stream_t *s,
 223                                       const es_format_t *fmt )
 224 {
 225     return s->pf_add( s, fmt );
 226 }
 227
 228 static inline void sout_StreamIdDel( sout_stream_t *s,
 229                                      void *id )
 230 {
 231     s->pf_del( s, id );
 232 }
 233
 234 static inline int sout_StreamIdSend( sout_stream_t *s,
 235                                      void *id, block_t *b )
 236 {
 237     return s->pf_send( s, id, b );
 238 }
 239
 240 static inline void sout_StreamFlush( sout_stream_t *s,
 241                                      void *id )
 242 {
 243     if (s->pf_flush)
 244         s->pf_flush( s, id );
 245 }
 246
 247 static inline int sout_StreamControlVa( sout_stream_t *s, int i_query, va_list args )
 248 {
 249     return s->pf_control ? s->pf_control( s, i_query, args ) : VLC_EGENERIC;
 250 }
 251
 252 static inline int sout_StreamControl( sout_stream_t *s, int i_query, ... )
 253 {
 254     va_list args;
 255     int     i_result;
 256
 257     va_start( args, i_query );
 258     i_result = sout_StreamControlVa( 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 struct vlc_memstream;
 284
 285 VLC_API int vlc_sdp_Start(struct vlc_memstream *, vlc_object_t *obj,
 286                           const char *cfgpref,
 287                           const struct sockaddr *src, size_t slen,
 288                           const struct sockaddr *addr, size_t alen) VLC_USED;
 289 VLC_API void sdp_AddMedia(struct vlc_memstream *, const char *type,
 290                           const char *protocol, int dport, unsigned pt,
 291                           bool bw_indep, unsigned bw, const char *ptname,
 292                           unsigned clockrate, unsigned channels,
 293                           const char *fmtp);
 294 VLC_API void sdp_AddAttribute(struct vlc_memstream *, const char *name,
 295                               const char *fmt, ...) VLC_FORMAT(3, 4);
 296
 297 /** Description module */
 298 typedef struct sout_description_data_t
 299 {
 300     int i_es;
 301     es_format_t **es;
 302     vlc_sem_t *sem;
 303 } sout_description_data_t;
 304
 305 /** @} */
 306
 307 #ifdef __cplusplus
 308 }
 309 #endif
 310
 311 #endif