X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_codec.h;h=b9a89d4cc714e3893187bf78605f3a82d5483478;hb=1f84bc065754ca1cdd0976d818ed1454e9e2b2cd;hp=79fa42132d77f6e1aa6fd539d32eaa84ea5f16b9;hpb=fbf4c8060d35617e39b50ae739307152d02ed951;p=vlc diff --git a/include/vlc_codec.h b/include/vlc_codec.h index 79fa42132d..b9a89d4cc7 100644 --- a/include/vlc_codec.h +++ b/include/vlc_codec.h @@ -1,35 +1,33 @@ /***************************************************************************** * vlc_codec.h: Definition of the decoder and encoder structures ***************************************************************************** - * Copyright (C) 1999-2003 the VideoLAN team + * Copyright (C) 1999-2003 VLC authors and VideoLAN * $Id$ * * Authors: Gildas Bazin * - * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - -#ifndef _VLC_CODEC_H -#define _VLC_CODEC_H 1 +#ifndef VLC_CODEC_H +#define VLC_CODEC_H 1 #include #include +#include +#include /** * \file @@ -66,36 +64,75 @@ struct decoder_t es_format_t fmt_out; /* Some decoders only accept packetized data (ie. not truncated) */ - vlc_bool_t b_need_packetized; + bool b_need_packetized; /* Tell the decoder if it is allowed to drop frames */ - vlc_bool_t b_pace_control; + bool b_pace_control; + /* */ picture_t * ( * pf_decode_video )( decoder_t *, block_t ** ); - aout_buffer_t * ( * pf_decode_audio )( 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/decoder_DeletePicture + * and decoder_LinkPicture/decoder_UnlinkPicture */ + 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 * ); + + /** + * 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 * ); + /* Audio output callbacks + * XXX use decoder_NewAudioBuffer/decoder_DeleteAudioBuffer */ + block_t *(*pf_aout_buffer_new)( decoder_t *, int ); - /* 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 * ); + /* SPU output callbacks + * XXX use decoder_NewSubpicture and decoder_DeleteSubpicture */ + subpicture_t *(*pf_spu_buffer_new)( decoder_t *, const subpicture_updater_t * ); + void (*pf_spu_buffer_del)( decoder_t *, subpicture_t * ); - /* SPU output callbacks */ - subpicture_t * ( * pf_spu_buffer_new) ( decoder_t * ); - void ( * pf_spu_buffer_del) ( decoder_t *, subpicture_t * ); + /* Input attachments + * XXX use decoder_GetInputAttachments */ + int (*pf_get_attachments)( decoder_t *p_dec, input_attachment_t ***ppp_attachment, int *pi_attachment ); + + /* 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; }; /** @@ -103,7 +140,7 @@ struct decoder_t */ /** - * \defgroup decoder Encoder + * \defgroup encoder Encoder * * The structure describing a Encoder * @@ -125,7 +162,7 @@ struct encoder_t es_format_t fmt_out; block_t * ( * pf_encode_video )( encoder_t *, picture_t * ); - block_t * ( * pf_encode_audio )( encoder_t *, aout_buffer_t * ); + block_t * ( * pf_encode_audio )( encoder_t *, block_t * ); block_t * ( * pf_encode_sub )( encoder_t *, subpicture_t * ); /* Common encoder options */ @@ -142,4 +179,68 @@ struct encoder_t * @} */ + +/** + * This function will return a new picture usable by a decoder as an output + * buffer. You have to release it using decoder_DeletePicture 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 will release a picture create by decoder_NewPicture. + */ +VLC_API void decoder_DeletePicture( decoder_t *, picture_t *p_picture ); + +/** + * This function will increase the picture reference count. + * (picture_Hold is not usable.) + */ +VLC_API void decoder_LinkPicture( decoder_t *, picture_t * ); + +/** + * This function will decrease the picture reference count. + * (picture_Release is not usable.) + */ +VLC_API void decoder_UnlinkPicture( decoder_t *, picture_t * ); + +/** + * This function will return a new audio buffer usable by a decoder as an + * output buffer. You have to release it using decoder_DeleteAudioBuffer + * or by returning 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 decoder_DeleteSubpicture 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 will release a subpicture created by decoder_NewSubicture. + */ +VLC_API void decoder_DeleteSubpicture( decoder_t *, subpicture_t *p_subpicture ); + +/** + * 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 */