/*****************************************************************************
- * vlc_codec.h: codec related structures
+ * vlc_codec.h: Definition of the decoder and encoder structures
*****************************************************************************
- * Copyright (C) 1999-2003 VideoLAN
+ * Copyright (C) 1999-2003 VLC authors and VideoLAN
* $Id$
*
* Authors: Gildas Bazin <gbazin@netcourrier.com>
*
- * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#ifndef _VLC_CODEC_H
-#define _VLC_CODEC_H 1
-#include "ninput.h"
+#ifndef VLC_CODEC_H
+#define VLC_CODEC_H 1
+
+#include <vlc_block.h>
+#include <vlc_es.h>
+#include <vlc_picture.h>
+#include <vlc_subpicture.h>
/**
* \file
* @{
*/
+/*
+ * BIG FAT WARNING : the code relies in the first 4 members of filter_t
+ * and decoder_t to be the same, so if you have anything to add, do it
+ * at the end of the structure.
+ */
struct decoder_t
{
VLC_COMMON_MEMBERS
module_t * p_module;
decoder_sys_t * p_sys;
- picture_t * ( * pf_decode_video )( decoder_t *, block_t ** );
- aout_buffer_t * ( * pf_decode_audio )( decoder_t *, block_t ** );
- void ( * pf_decode_sub) ( decoder_t *, block_t ** );
- block_t * ( * pf_packetize ) ( decoder_t *, block_t ** );
-
- /* Some decoders only accept packetized data (ie. not truncated) */
- vlc_bool_t b_need_packetized;
-
/* Input format ie from demuxer (XXX: a lot of field could be invalid) */
es_format_t fmt_in;
/* Output format of decoder/packetizer */
es_format_t fmt_out;
+ /* Some decoders only accept packetized data (ie. not truncated) */
+ bool b_need_packetized;
+
+ /* Tell the decoder if it is allowed to drop frames */
+ bool b_pace_control;
+
+ /* */
+ picture_t * ( * pf_decode_video )( decoder_t *, block_t ** );
+ block_t * ( * pf_decode_audio )( decoder_t *, block_t ** );
+ subpicture_t * ( * pf_decode_sub) ( decoder_t *, block_t ** );
+ block_t * ( * pf_packetize ) ( decoder_t *, block_t ** );
+
+ /* Closed Caption (CEA 608/708) extraction.
+ * If set, it *may* be called after pf_decode_video/pf_packetize
+ * returned data. It should return CC for the pictures returned by the
+ * last pf_packetize/pf_decode_video call only,
+ * pb_present will be used to known which cc channel are present (but
+ * globaly, not necessary for the current packet */
+ block_t * ( * pf_get_cc ) ( decoder_t *, bool pb_present[4] );
+
+ /* Meta data at codec level
+ * The decoder owner set it back to NULL once it has retreived what it needs.
+ * The decoder owner is responsible of its release except when you overwrite it.
+ */
+ vlc_meta_t *p_description;
+
/*
- * Buffers allocation
+ * Owner fields
+ * XXX You MUST not use them directly.
*/
+ /* Video output callbacks
+ * XXX use decoder_NewPicture */
+ int (*pf_vout_format_update)( decoder_t * );
+ picture_t *(*pf_vout_buffer_new)( decoder_t * );
+
+ /**
+ * Number of extra (ie in addition to the DPB) picture buffers
+ * needed for decoding.
+ */
+ int i_extra_picture_buffers;
+
/* Audio output callbacks */
- aout_buffer_t * ( * pf_aout_buffer_new) ( decoder_t *, int );
- void ( * pf_aout_buffer_del) ( decoder_t *, aout_buffer_t * );
+ int (*pf_aout_format_update)( decoder_t * );
+
+ /* SPU output callbacks
+ * XXX use decoder_NewSubpicture */
+ subpicture_t *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * );
+
+ /* Input attachments
+ * XXX use decoder_GetInputAttachments */
+ int (*pf_get_attachments)( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment );
- /* Video output callbacks */
- picture_t * ( * pf_vout_buffer_new) ( decoder_t * );
- void ( * pf_vout_buffer_del) ( decoder_t *, picture_t * );
- void ( * pf_picture_link) ( decoder_t *, picture_t * );
- void ( * pf_picture_unlink) ( decoder_t *, picture_t * );
+ /* Display date
+ * XXX use decoder_GetDisplayDate */
+ mtime_t (*pf_get_display_date)( decoder_t *, mtime_t );
+ /* Display rate
+ * XXX use decoder_GetDisplayRate */
+ int (*pf_get_display_rate)( decoder_t * );
/* Private structure for the owner of the decoder */
decoder_owner_sys_t *p_owner;
+
+ bool b_error;
};
/**
*/
/**
- * \defgroup decoder Encoder
+ * \defgroup encoder Encoder
*
* The structure describing a Encoder
*
module_t * p_module;
encoder_sys_t * p_sys;
- block_t * ( * pf_header )( encoder_t * );
- block_t * ( * pf_encode_video )( encoder_t *, picture_t * );
- block_t * ( * pf_encode_audio )( encoder_t *, aout_buffer_t * );
-
/* Properties of the input data fed to the encoder */
es_format_t fmt_in;
/* Properties of the output of the encoder */
es_format_t fmt_out;
- /* Number of threads to use during encoding */
- int i_threads;
+ block_t * ( * pf_encode_video )( encoder_t *, picture_t * );
+ block_t * ( * pf_encode_audio )( encoder_t *, block_t * );
+ block_t * ( * pf_encode_sub )( encoder_t *, subpicture_t * );
+
+ /* Common encoder options */
+ int i_threads; /* Number of threads to use during encoding */
+ int i_iframes; /* One I frame per i_iframes */
+ int i_bframes; /* One B frame per i_bframes */
+ int i_tolerance; /* Bitrate tolerance */
/* Encoder config */
- sout_cfg_t *p_cfg;
+ config_chain_t *p_cfg;
};
/**
* @}
*/
+
+/**
+ * This function notifies the video output pipeline of a new video output
+ * format (fmt_out.video). If there is currently no video output or if the
+ * video output format has changed, a new audio video will be set up.
+ * @return 0 if the video output is working, -1 if not. */
+static inline int decoder_UpdateVideoFormat( decoder_t *dec )
+{
+ if( dec->pf_vout_format_update != NULL )
+ return dec->pf_vout_format_update( dec );
+ else
+ return -1;
+}
+
+/**
+ * This function will return a new picture usable by a decoder as an output
+ * buffer. You have to release it using picture_Release() or by returning
+ * it to the caller as a pf_decode_video return value.
+ */
+VLC_API picture_t * decoder_NewPicture( decoder_t * ) VLC_USED;
+
+/**
+ * This function notifies the audio output pipeline of a new audio output
+ * format (fmt_out.audio). If there is currently no audio output or if the
+ * audio output format has changed, a new audio output will be set up.
+ * @return 0 if the audio output is working, -1 if not. */
+static inline int decoder_UpdateAudioFormat( decoder_t *dec )
+{
+ if( dec->pf_aout_format_update != NULL )
+ return dec->pf_aout_format_update( dec );
+ else
+ return -1;
+}
+
+/**
+ * This function will return a new audio buffer usable by a decoder as an
+ * output buffer. It must be released with block_Release() or returned it to
+ * the caller as a pf_decode_audio return value.
+ */
+VLC_API block_t * decoder_NewAudioBuffer( decoder_t *, int i_size ) VLC_USED;
+
+/**
+ * This function will return a new subpicture usable by a decoder as an output
+ * buffer. You have to release it using subpicture_Delete() or by returning
+ * it to the caller as a pf_decode_sub return value.
+ */
+VLC_API subpicture_t * decoder_NewSubpicture( decoder_t *, const subpicture_updater_t * ) VLC_USED;
+
+/**
+ * This function gives all input attachments at once.
+ *
+ * You MUST release the returned values
+ */
+VLC_API int decoder_GetInputAttachments( decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment );
+
+/**
+ * This function converts a decoder timestamp into a display date comparable
+ * to mdate().
+ * You MUST use it *only* for gathering statistics about speed.
+ */
+VLC_API mtime_t decoder_GetDisplayDate( decoder_t *, mtime_t ) VLC_USED;
+
+/**
+ * This function returns the current input rate.
+ * You MUST use it *only* for gathering statistics about speed.
+ */
+VLC_API int decoder_GetDisplayRate( decoder_t * ) VLC_USED;
+
#endif /* _VLC_CODEC_H */
projects / vlc / blobdiff