include/vlc_codec.h

   1 /*****************************************************************************
   2  * vlc_codec.h: Definition of the decoder and encoder structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 #ifndef _VLC_CODEC_H
  29 #define _VLC_CODEC_H 1
  30
  31 #include <vlc_block.h>
  32 #include <vlc_es.h>
  33
  34 /**
  35  * \file
  36  * This file defines the structure and types used by decoders and encoders
  37  */
  38
  39 typedef struct decoder_owner_sys_t decoder_owner_sys_t;
  40
  41 /**
  42  * \defgroup decoder Decoder
  43  *
  44  * The structure describing a decoder
  45  *
  46  * @{
  47  */
  48
  49 /*
  50  * BIG FAT WARNING : the code relies in the first 4 members of filter_t
  51  * and decoder_t to be the same, so if you have anything to add, do it
  52  * at the end of the structure.
  53  */
  54 struct decoder_t
  55 {
  56     VLC_COMMON_MEMBERS
  57
  58     /* Module properties */
  59     module_t *          p_module;
  60     decoder_sys_t *     p_sys;
  61
  62     /* Input format ie from demuxer (XXX: a lot of field could be invalid) */
  63     es_format_t         fmt_in;
  64
  65     /* Output format of decoder/packetizer */
  66     es_format_t         fmt_out;
  67
  68     /* Some decoders only accept packetized data (ie. not truncated) */
  69     vlc_bool_t          b_need_packetized;
  70
  71     /* Tell the decoder if it is allowed to drop frames */
  72     vlc_bool_t          b_pace_control;
  73
  74     /* */
  75     picture_t *         ( * pf_decode_video )( decoder_t *, block_t ** );
  76     aout_buffer_t *     ( * pf_decode_audio )( decoder_t *, block_t ** );
  77     subpicture_t *      ( * pf_decode_sub)   ( decoder_t *, block_t ** );
  78     block_t *           ( * pf_packetize )   ( decoder_t *, block_t ** );
  79
  80     /* Closed Caption (CEA 608/708) extraction.
  81      * If set, it *may* be called after pf_decode_video/pf_packetize
  82      * returned data. It should return CC for the pictures returned by the
  83      * last pf_packetize/pf_decode_video call only,
  84      * pb_present will be used to known which cc channel are present (but
  85      * globaly, not necessary for the current packet */
  86     block_t *           ( * pf_get_cc )      ( decoder_t *, vlc_bool_t pb_present[4] );
  87
  88     /*
  89      * Buffers allocation
  90      */
  91
  92     /* Audio output callbacks */
  93     aout_buffer_t * ( * pf_aout_buffer_new) ( decoder_t *, int );
  94     void            ( * pf_aout_buffer_del) ( decoder_t *, aout_buffer_t * );
  95
  96     /* Video output callbacks */
  97     picture_t     * ( * pf_vout_buffer_new) ( decoder_t * );
  98     void            ( * pf_vout_buffer_del) ( decoder_t *, picture_t * );
  99     void            ( * pf_picture_link)    ( decoder_t *, picture_t * );
 100     void            ( * pf_picture_unlink)  ( decoder_t *, picture_t * );
 101
 102     /* SPU output callbacks */
 103     subpicture_t *  ( * pf_spu_buffer_new) ( decoder_t * );
 104     void            ( * pf_spu_buffer_del) ( decoder_t *, subpicture_t * );
 105
 106     /* Private structure for the owner of the decoder */
 107     decoder_owner_sys_t *p_owner;
 108 };
 109
 110 /**
 111  * @}
 112  */
 113
 114 /**
 115  * \defgroup decoder Encoder
 116  *
 117  * The structure describing a Encoder
 118  *
 119  * @{
 120  */
 121
 122 struct encoder_t
 123 {
 124     VLC_COMMON_MEMBERS
 125
 126     /* Module properties */
 127     module_t *          p_module;
 128     encoder_sys_t *     p_sys;
 129
 130     /* Properties of the input data fed to the encoder */
 131     es_format_t         fmt_in;
 132
 133     /* Properties of the output of the encoder */
 134     es_format_t         fmt_out;
 135
 136     block_t *           ( * pf_encode_video )( encoder_t *, picture_t * );
 137     block_t *           ( * pf_encode_audio )( encoder_t *, aout_buffer_t * );
 138     block_t *           ( * pf_encode_sub )( encoder_t *, subpicture_t * );
 139
 140     /* Common encoder options */
 141     int i_threads;               /* Number of threads to use during encoding */
 142     int i_iframes;               /* One I frame per i_iframes */
 143     int i_bframes;               /* One B frame per i_bframes */
 144     int i_tolerance;             /* Bitrate tolerance */
 145
 146     /* Encoder config */
 147     config_chain_t *p_cfg;
 148 };
 149
 150 /**
 151  * @}
 152  */
 153
 154 VLC_EXPORT( input_attachment_t *, decoder_GetInputAttachment, ( decoder_t *, const char *psz_name ) );
 155 VLC_EXPORT( int, decoder_GetInputAttachments, ( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment ) );
 156 VLC_EXPORT( mtime_t, decoder_GetDisplayDate, ( decoder_t *, mtime_t ) );
 157
 158 #endif /* _VLC_CODEC_H */