include/vlc_sout.h

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