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 /**
  31  * \file
  32  * This file defines structures and functions for stream ouput in vlc
  33  */
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #include <vlc_es.h>
  40
  41 /** Stream output instance */
  42 struct sout_instance_t
  43 {
  44     VLC_COMMON_MEMBERS
  45
  46     char *psz_sout;
  47     char *psz_chain;
  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 /** Stream output statistics */
  63 typedef enum
  64 {
  65     SOUT_STATISTIC_DECODED_VIDEO,
  66     SOUT_STATISTIC_DECODED_AUDIO,
  67     SOUT_STATISTIC_DECODED_SUBTITLE,
  68
  69     /* Use them only if you do not goes through a access_out module */
  70     SOUT_STATISTIC_SENT_PACKET,
  71     SOUT_STATISTIC_SENT_BYTE,
  72
  73 } sout_statistic_t;
  74
  75 VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
  76
  77 /****************************************************************************
  78  * sout_stream_id_t: opaque (private for all sout_stream_t)
  79  ****************************************************************************/
  80 typedef struct sout_stream_id_t  sout_stream_id_t;
  81
  82 /** Stream output access_output */
  83 struct sout_access_out_t
  84 {
  85     VLC_COMMON_MEMBERS
  86
  87     module_t                *p_module;
  88     char                    *psz_access;
  89
  90     int                      i_writes;
  91     /** Local counter reset each time it is transferred to stats */
  92     int64_t                  i_sent_bytes;
  93
  94     char                    *psz_path;
  95     sout_access_out_sys_t   *p_sys;
  96     int                     (*pf_seek)( sout_access_out_t *, off_t );
  97     ssize_t                 (*pf_read)( sout_access_out_t *, block_t * );
  98     ssize_t                 (*pf_write)( sout_access_out_t *, block_t * );
  99     int                     (*pf_control)( sout_access_out_t *, int, va_list);
 100
 101     config_chain_t              *p_cfg;
 102     sout_instance_t         *p_sout;
 103 };
 104
 105 VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, const char *psz_access, const char *psz_name ) );
 106 VLC_EXPORT( void,               sout_AccessOutDelete, ( sout_access_out_t * ) );
 107 VLC_EXPORT( int,                sout_AccessOutSeek,   ( sout_access_out_t *, off_t ) );
 108 VLC_EXPORT( ssize_t,            sout_AccessOutRead,   ( sout_access_out_t *, block_t * ) );
 109 VLC_EXPORT( ssize_t,            sout_AccessOutWrite,  ( sout_access_out_t *, block_t * ) );
 110 VLC_EXPORT( int,                sout_AccessOutControl,( sout_access_out_t *, int, va_list ) );
 111
 112 /** Muxer structure */
 113 struct  sout_mux_t
 114 {
 115     VLC_COMMON_MEMBERS
 116     module_t            *p_module;
 117
 118     sout_instance_t     *p_sout;
 119
 120     char                *psz_mux;
 121     config_chain_t          *p_cfg;
 122
 123     sout_access_out_t   *p_access;
 124
 125     int                 (*pf_addstream)( sout_mux_t *, sout_input_t * );
 126     int                 (*pf_delstream)( sout_mux_t *, sout_input_t * );
 127     int                 (*pf_mux)      ( sout_mux_t * );
 128     int                 (*pf_control)  ( sout_mux_t *, int, va_list );
 129
 130     /* here are all inputs accepted by muxer */
 131     int                 i_nb_inputs;
 132     sout_input_t        **pp_inputs;
 133
 134     /* mux private */
 135     sout_mux_sys_t      *p_sys;
 136
 137     /* XXX private to stream_output.c */
 138     /* if muxer doesn't support adding stream at any time then we first wait
 139      *  for stream then we refuse all stream and start muxing */
 140     bool  b_add_stream_any_time;
 141     bool  b_waiting_stream;
 142     /* we wait one second after first stream added */
 143     mtime_t     i_add_stream_start;
 144 };
 145
 146 enum sout_mux_query_e
 147 {
 148     /* capabilities */
 149     MUX_CAN_ADD_STREAM_WHILE_MUXING,    /* arg1= bool *,      res=cannot fail */
 150     /* properties */
 151     MUX_GET_ADD_STREAM_WAIT,            /* arg1= bool *,      res=cannot fail */
 152     MUX_GET_MIME,                       /* arg1= char **            res=can fail    */
 153 };
 154
 155 struct sout_input_t
 156 {
 157     sout_instance_t *p_sout;
 158
 159     es_format_t     *p_fmt;
 160     block_fifo_t    *p_fifo;
 161
 162     void            *p_sys;
 163 };
 164
 165
 166 VLC_EXPORT( sout_mux_t *,   sout_MuxNew,          ( sout_instance_t*, char *, sout_access_out_t * ) );
 167 VLC_EXPORT( sout_input_t *, sout_MuxAddStream,    ( sout_mux_t *, es_format_t * ) );
 168 VLC_EXPORT( void,           sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
 169 VLC_EXPORT( void,           sout_MuxDelete,       ( sout_mux_t * ) );
 170 VLC_EXPORT( void,           sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t  *, block_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     char              *psz_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_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
 211 VLC_EXPORT( void,            sout_StreamDelete, ( sout_stream_t * ) );
 212
 213 static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
 214 {
 215     return s->pf_add( s, fmt );
 216 }
 217 static inline int sout_StreamIdDel( sout_stream_t *s, sout_stream_id_t *id )
 218 {
 219     return s->pf_del( s, id );
 220 }
 221 static inline int sout_StreamIdSend( sout_stream_t *s, sout_stream_id_t *id, block_t *b )
 222 {
 223     return s->pf_send( s, id, b );
 224 }
 225
 226 /****************************************************************************
 227  * Announce handler
 228  ****************************************************************************/
 229 VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, ( sout_instance_t *, const char *, const char *, announce_method_t* ) );
 230 VLC_EXPORT( int,                sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
 231
 232 VLC_EXPORT(announce_method_t*,   sout_SAPMethod, (void) );
 233 VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
 234
 235 /** SDP */
 236
 237 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 ) );
 238 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) );
 239 VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
 240
 241
 242 #ifdef __cplusplus
 243 }
 244 #endif
 245
 246 #endif