/*****************************************************************************
* stream_output.h : stream output module
*****************************************************************************
- * Copyright (C) 2002-2005 the VideoLAN team
+ * Copyright (C) 2002-2008 the VideoLAN team
* $Id$
*
* Authors: Christophe Massiot <massiot@via.ecp.fr>
* Laurent Aimar <fenrir@via.ecp.fr>
* Eric Petit <titer@videolan.org>
* Jean-Paul Saman <jpsaman #_at_# m2x.nl>
+ * RĂ©mi Denis-Courmont
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#if !defined( __LIBVLC__ )
- #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_SOUT_H_
+#define VLC_SOUT_H_
-#ifndef _VLC_SOUT_H_
-#define _VLC_SOUT_H_
+/**
+ * \file
+ * This file defines structures and functions for stream ouput in vlc
+ */
#ifdef __cplusplus
extern "C" {
VLC_COMMON_MEMBERS
char *psz_sout;
- char *psz_chain;
/* meta data (Read only) XXX it won't be set before the first packet received */
vlc_meta_t *p_meta;
sout_instance_sys_t *p_sys;
};
+/** Stream output statistics */
+typedef enum
+{
+ SOUT_STATISTIC_DECODED_VIDEO,
+ SOUT_STATISTIC_DECODED_AUDIO,
+ SOUT_STATISTIC_DECODED_SUBTITLE,
+
+ /* Use them only if you do not goes through a access_out module */
+ SOUT_STATISTIC_SENT_PACKET,
+ SOUT_STATISTIC_SENT_BYTE,
+
+} sout_statistic_t;
+
+VLC_EXPORT( void, sout_UpdateStatistic, ( sout_instance_t *p_sout, sout_statistic_t, int ) );
+
/****************************************************************************
* sout_stream_id_t: opaque (private for all sout_stream_t)
****************************************************************************/
VLC_COMMON_MEMBERS
module_t *p_module;
-
- sout_instance_t *p_sout;
-
char *psz_access;
- config_chain_t *p_cfg;
int i_writes;
/** Local counter reset each time it is transferred to stats */
int64_t i_sent_bytes;
- char *psz_name;
+ char *psz_path;
sout_access_out_sys_t *p_sys;
int (*pf_seek)( sout_access_out_t *, off_t );
- int (*pf_read)( sout_access_out_t *, block_t * );
- int (*pf_write)( sout_access_out_t *, block_t * );
+ ssize_t (*pf_read)( sout_access_out_t *, block_t * );
+ ssize_t (*pf_write)( sout_access_out_t *, block_t * );
+ int (*pf_control)( sout_access_out_t *, int, va_list );
+
+ config_chain_t *p_cfg;
};
-VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( sout_instance_t *, char *psz_access, char *psz_name ) );
-VLC_EXPORT( void, sout_AccessOutDelete, ( sout_access_out_t * ) );
-VLC_EXPORT( int, sout_AccessOutSeek, ( sout_access_out_t *, off_t ) );
-VLC_EXPORT( int, sout_AccessOutRead, ( sout_access_out_t *, block_t * ) );
-VLC_EXPORT( int, sout_AccessOutWrite, ( sout_access_out_t *, block_t * ) );
+enum access_out_query_e
+{
+ ACCESS_OUT_CONTROLS_PACE, /* arg1=bool *, can fail (assume true) */
+};
+
+VLC_EXPORT( sout_access_out_t *,sout_AccessOutNew, ( vlc_object_t *, const char *psz_access, const char *psz_name ) LIBVLC_USED );
+#define sout_AccessOutNew( obj, access, name ) \
+ sout_AccessOutNew( VLC_OBJECT(obj), access, name )
+VLC_EXPORT( void, sout_AccessOutDelete, ( sout_access_out_t * ) );
+VLC_EXPORT( int, sout_AccessOutSeek, ( sout_access_out_t *, off_t ) );
+VLC_EXPORT( ssize_t, sout_AccessOutRead, ( sout_access_out_t *, block_t * ) );
+VLC_EXPORT( ssize_t, sout_AccessOutWrite, ( sout_access_out_t *, block_t * ) );
+VLC_EXPORT( int, sout_AccessOutControl, ( sout_access_out_t *, int, ... ) );
+
+static inline bool sout_AccessOutCanControlPace( sout_access_out_t *p_ao )
+{
+ bool b;
+ if( sout_AccessOutControl( p_ao, ACCESS_OUT_CONTROLS_PACE, &b ) )
+ return true;
+ return b;
+}
/** Muxer structure */
struct sout_mux_t
/* XXX private to stream_output.c */
/* if muxer doesn't support adding stream at any time then we first wait
* for stream then we refuse all stream and start muxing */
- vlc_bool_t b_add_stream_any_time;
- vlc_bool_t b_waiting_stream;
+ bool b_add_stream_any_time;
+ bool b_waiting_stream;
/* we wait one second after first stream added */
mtime_t i_add_stream_start;
};
enum sout_mux_query_e
{
/* capabilities */
- MUX_CAN_ADD_STREAM_WHILE_MUXING, /* arg1= vlc_bool_t *, res=cannot fail */
+ MUX_CAN_ADD_STREAM_WHILE_MUXING, /* arg1= bool *, res=cannot fail */
/* properties */
- MUX_GET_ADD_STREAM_WAIT, /* arg1= vlc_bool_t *, res=cannot fail */
+ MUX_GET_ADD_STREAM_WAIT, /* arg1= bool *, res=cannot fail */
MUX_GET_MIME, /* arg1= char ** res=can fail */
};
};
-VLC_EXPORT( sout_mux_t *, sout_MuxNew, ( sout_instance_t*, char *, sout_access_out_t * ) );
-VLC_EXPORT( sout_input_t *, sout_MuxAddStream, ( sout_mux_t *, es_format_t * ) );
+VLC_EXPORT( sout_mux_t *, sout_MuxNew, ( sout_instance_t*, const char *, sout_access_out_t * ) LIBVLC_USED );
+VLC_EXPORT( sout_input_t *, sout_MuxAddStream, ( sout_mux_t *, es_format_t * ) LIBVLC_USED );
VLC_EXPORT( void, sout_MuxDeleteStream, ( sout_mux_t *, sout_input_t * ) );
VLC_EXPORT( void, sout_MuxDelete, ( sout_mux_t * ) );
VLC_EXPORT( void, sout_MuxSendBuffer, ( sout_mux_t *, sout_input_t *, block_t * ) );
+VLC_EXPORT( int, sout_MuxGetStream, (sout_mux_t *, int , mtime_t *));
static inline int sout_MuxControl( sout_mux_t *p_mux, int i_query, ... )
{
char *psz_name;
config_chain_t *p_cfg;
- char *psz_next;
+ sout_stream_t *p_next;
/* Subpicture unit */
spu_t *p_spu;
sout_stream_sys_t *p_sys;
};
-VLC_EXPORT( sout_stream_t *, sout_StreamNew, ( sout_instance_t *, char *psz_chain ) );
-VLC_EXPORT( void, sout_StreamDelete, ( sout_stream_t * ) );
+VLC_EXPORT( void, sout_StreamChainDelete, (sout_stream_t *p_first, sout_stream_t *p_last ) );
+VLC_EXPORT( sout_stream_t *, sout_StreamChainNew, (sout_instance_t *p_sout,
+ char *psz_chain, sout_stream_t *p_next, sout_stream_t **p_last) LIBVLC_USED );
static inline sout_stream_id_t *sout_StreamIdAdd( sout_stream_t *s, es_format_t *fmt )
{
}
/****************************************************************************
- * Announce handler mess
+ * Encoder
****************************************************************************/
-struct sap_session_t;
-struct session_descriptor_t
-{
- char *psz_name;
- char *psz_uri;
- int i_port;
- int i_payload; /* SAP Payload type */
+VLC_EXPORT( encoder_t *, sout_EncoderCreate, ( vlc_object_t *obj ) );
+#define sout_EncoderCreate(o) sout_EncoderCreate(VLC_OBJECT(o))
- char *psz_group;
+/****************************************************************************
+ * Announce handler
+ ****************************************************************************/
+VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, ( vlc_object_t *, const char *, const char *, announce_method_t* ) LIBVLC_USED );
+VLC_EXPORT( int, sout_AnnounceUnRegister, (vlc_object_t *,session_descriptor_t* ) );
+#define sout_AnnounceRegisterSDP(o, sdp, addr, m) \
+ sout_AnnounceRegisterSDP(VLC_OBJECT (o), sdp, addr, m)
+#define sout_AnnounceUnRegister(o, a) \
+ sout_AnnounceUnRegister(VLC_OBJECT (o), a)
- char *psz_sdp;
- vlc_bool_t b_rtp;
-};
+VLC_EXPORT(announce_method_t*, sout_SAPMethod, (void) LIBVLC_USED );
+VLC_EXPORT(void, sout_MethodRelease, (announce_method_t *) );
+
+/** SDP */
-VLC_EXPORT( int, sout_AnnounceRegister, (sout_instance_t *,session_descriptor_t*, announce_method_t* ) );
-VLC_EXPORT(session_descriptor_t*,sout_AnnounceRegisterSDP, (sout_instance_t *,const char *, const char *, announce_method_t* ) );
-VLC_EXPORT( int, sout_AnnounceUnRegister, (sout_instance_t *,session_descriptor_t* ) );
+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 ) LIBVLC_USED );
+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) );
+VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
-VLC_EXPORT(session_descriptor_t*,sout_AnnounceSessionCreate, (void) );
-VLC_EXPORT(void, sout_AnnounceSessionDestroy, (session_descriptor_t *) );
-VLC_EXPORT(announce_method_t*, sout_SAPMethod, (void) );
#ifdef __cplusplus
}