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

   1 /*****************************************************************************
   2  * stream_output.h : stream output module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2007 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  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef _VLC_SOUT_H_
  28 #define _VLC_SOUT_H_
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <vlc_es.h>
  35
  36 /** Stream output instance */
  37 struct sout_instance_t
  38 {
  39     VLC_COMMON_MEMBERS
  40
  41     char *psz_sout;
  42     char *psz_chain;
  43
  44     /* meta data (Read only) XXX it won't be set before the first packet received */
  45     vlc_meta_t          *p_meta;
  46
  47     /** count of output that can't control the space */
  48     int                 i_out_pace_nocontrol;
  49
  50     vlc_mutex_t         lock;
  51     sout_stream_t       *p_stream;
  52
  53     /** Private */
  54     sout_instance_sys_t *p_sys;
  55 };
  56
  57 /** Stream output statistics */
  58 typedef enum
  59 {
  60     SOUT_STATISTIC_DECODED_VIDEO,
  61     SOUT_STATISTIC_DECODED_AUDIO,
  62     SOUT_STATISTIC_DECODED_SUBTITLE,
  63
  64     /* Use them only if you do not goes through a access_out module */
  65     SOUT_STATISTIC_SENT_PACKET,
  66     SOUT_STATISTIC_SENT_BYTE,
  67
  68 } sout_statistic_t;
  69
  70 VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
  71
  72 /****************************************************************************
  73  * sout_stream_id_t: opaque (private for all sout_stream_t)
  74  ****************************************************************************/
  75 typedef struct sout_stream_id_t  sout_stream_id_t;
  76
  77 /** Stream output access_output */
  78 struct sout_access_out_t
  79 {
  80     VLC_COMMON_MEMBERS
  81
  82     module_t                *p_module;
  83     char                    *psz_access;
  84
  85     int                      i_writes;
  86     /** Local counter reset each time it is transferred to stats */
  87     int64_t                  i_sent_bytes;
  88
  89     char                    *psz_path;
  90     sout_access_out_sys_t   *p_sys;
  91     int                     (*pf_seek)( sout_access_out_t *, off_t );
  92     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
  93     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
  94     int                     (*pf_control)( sout_access_out_t *, int, va_list);
  95
  96     config_chain_t              *p_cfg;
  97     sout_instance_t         *p_sout;
  98 };
  99
 100 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, const char *psz_access, const char *psz_name ) );
 101 VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
 102 VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
 103 VLC_EXPORT( ssize_t,            sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
 104 VLC_EXPORT( ssize_t,            sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
 105 VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, va_list ) );
 106
 107 /** Muxer structure */
 108 struct  sout_mux_t
 109 {
 110     VLC_COMMON_MEMBERS
 111     module_t            *p_module;
 112
 113     sout_instance_t     *p_sout;
 114
 115     char                *psz_mux;
 116     config_chain_t          *p_cfg;
 117
 118     sout_access_out_t   *p_access;
 119
 120     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 121     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
 122     int                 (*pf_mux)      ( sout_mux_t * );
 123     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 124
 125     /* here are all inputs accepted by muxer */
 126     int                 i_nb_inputs;
 127     sout_input_t        **pp_inputs;
 128
 129     /* mux private */
 130     sout_mux_sys_t      *p_sys;
 131
 132     /* XXX private to stream_output.c */
 133     /* if muxer doesn't support adding stream at any time then we first wait
 134      *  for stream then we refuse all stream and start muxing */
 135     bool  b_add_stream_any_time;
 136     bool  b_waiting_stream;
 137     /* we wait one second after first stream added */
 138     mtime_t     i_add_stream_start;
 139 };
 140
 141 enum sout_mux_query_e
 142 {
 143     /* capabilities */
 144     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
 145     /* properties */
 146     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
 147     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 148 };
 149
 150 struct sout_input_t
 151 {
 152     sout_instance_t *p_sout;
 153
 154     es_format_t     *p_fmt;
 155     block_fifo_t    *p_fifo;
 156
 157     void            *p_sys;
 158 };
 159
 160
 161 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
 162 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
 163 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
 164 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
 165 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_t * ) );
 166
 167 static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
 168 {
 169     va_list args;
 170     int     i_result;
 171
 172     va_start( args, i_query );
 173     i_result = p_mux->pf_control( p_mux, i_query, args );
 174     va_end( args );
 175     return i_result;
 176 }
 177
 178 /****************************************************************************
 179  * sout_stream:
 180  ****************************************************************************/
 181 struct sout_stream_t
 182 {
 183     VLC_COMMON_MEMBERS
 184
 185     module_t          *p_module;
 186     sout_instance_t   *p_sout;
 187
 188     char              *psz_name;
 189     config_chain_t        *p_cfg;
 190     char              *psz_next;
 191
 192     /* Subpicture unit */
 193     spu_t             *p_spu;
 194
 195     /* add, remove a stream */
 196     sout_stream_id_t *(*pf_add)( sout_stream_t *, es_format_t * );
 197     int               (*pf_del)( sout_stream_t *, sout_stream_id_t * );
 198     /* manage a packet */
 199     int               (*pf_send)( sout_stream_t *, sout_stream_id_t *, block_t* );
 200
 201     /* private */
 202     sout_stream_sys_t *p_sys;
 203 };
 204
 205 VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
 206 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
 207
 208 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 209 {
 210     return s->pf_add( s, fmt );
 211 }
 212 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
 213 {
 214     return s->pf_del( s, id );
 215 }
 216 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
 217 {
 218     return s->pf_send( s, id, b );
 219 }
 220
 221 /****************************************************************************
 222  * Announce handler
 223  ****************************************************************************/
 224 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, ( sout_instance_t *, const char *, const char *, announce_method_t* ) );
 225 VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
 226
 227 VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
 228 VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
 229
 230 /** SDP */
 231
 232 VLC_EXPORT( 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 ) );
 233 VLC_EXPORT( 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) );
 234 VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
 235
 236
 237 #ifdef __cplusplus
 238 }
 239 #endif
 240
 241 #endif