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