libavcodec/vda.h
d66ee6ac
 /*
  * VDA HW acceleration
  *
  * copyright (c) 2011 Sebastien Zwickert
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg 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.
  *
  * FFmpeg 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
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef AVCODEC_VDA_H
 #define AVCODEC_VDA_H
 
7c59b5c2
 /**
  * @file
  * @ingroup lavc_codec_hwaccel_vda
  * Public libavcodec VDA header.
  */
 
67afcefb
 #include "libavcodec/avcodec.h"
3c379706
 
d66ee6ac
 #include <stdint.h>
 
 // emmintrin.h is unable to compile with -std=c99 -Werror=missing-prototypes
 // http://openradar.appspot.com/8026390
 #undef __GNUC_STDC_INLINE__
 
9837442a
 #define Picture QuickdrawPicture
d66ee6ac
 #include <VideoDecodeAcceleration/VDADecoder.h>
9837442a
 #undef Picture
d66ee6ac
 
c25e9292
 #include "libavcodec/version.h"
 
31a0ca9e
 // extra flags not defined in VDADecoder.h
 enum {
     kVDADecodeInfo_Asynchronous = 1UL << 0,
     kVDADecodeInfo_FrameDropped = 1UL << 1
 };
 
d66ee6ac
 /**
7c59b5c2
  * @defgroup lavc_codec_hwaccel_vda VDA
  * @ingroup lavc_codec_hwaccel
  *
  * @{
  */
 
d66ee6ac
 /**
  * This structure is used to provide the necessary configurations and data
  * to the VDA FFmpeg HWAccel implementation.
  *
  * The application must make it available as AVCodecContext.hwaccel_context.
  */
 struct vda_context {
     /**
063910f5
      * VDA decoder object.
      *
      * - encoding: unused
      * - decoding: Set/Unset by libavcodec.
      */
d66ee6ac
     VDADecoder          decoder;
 
     /**
063910f5
      * The Core Video pixel buffer that contains the current image data.
      *
      * encoding: unused
      * decoding: Set by libavcodec. Unset by user.
      */
7f3dfd20
     CVPixelBufferRef    cv_buffer;
 
     /**
063910f5
      * Use the hardware decoder in synchronous mode.
      *
      * encoding: unused
      * decoding: Set by user.
      */
7f3dfd20
     int                 use_sync_decoding;
 
d66ee6ac
     /**
063910f5
      * The frame width.
      *
      * - encoding: unused
      * - decoding: Set/Unset by user.
      */
d66ee6ac
     int                 width;
 
     /**
063910f5
      * The frame height.
      *
      * - encoding: unused
      * - decoding: Set/Unset by user.
      */
d66ee6ac
     int                 height;
 
     /**
063910f5
      * The frame format.
      *
      * - encoding: unused
      * - decoding: Set/Unset by user.
      */
d66ee6ac
     int                 format;
701e5348
 
     /**
063910f5
      * The pixel format for output image buffers.
      *
      * - encoding: unused
      * - decoding: Set/Unset by user.
      */
701e5348
     OSType              cv_pix_fmt_type;
89d7f926
 
     /**
31a46750
      * unused
063910f5
      */
cfc680ab
     uint8_t             *priv_bitstream;
89d7f926
 
     /**
31a46750
      * unused
063910f5
      */
cfc680ab
     int                 priv_bitstream_size;
89d7f926
 
     /**
31a46750
      * unused
063910f5
      */
cfc680ab
     int                 priv_allocated_size;
ffd7fd79
 
     /**
      * Use av_buffer to manage buffer.
      * When the flag is set, the CVPixelBuffers returned by the decoder will
      * be released automatically, so you have to retain them if necessary.
      * Not setting this flag may cause memory leak.
      *
      * encoding: unused
      * decoding: Set by user.
      */
     int                 use_ref_buffer;
d66ee6ac
 };
 
186980bf
 /** Create the video decoder. */
d66ee6ac
 int ff_vda_create_decoder(struct vda_context *vda_ctx,
                           uint8_t *extradata,
                           int extradata_size);
 
186980bf
 /** Destroy the video decoder. */
d66ee6ac
 int ff_vda_destroy_decoder(struct vda_context *vda_ctx);
 
7c59b5c2
 /**
67afcefb
  * This struct holds all the information that needs to be passed
  * between the caller and libavcodec for initializing VDA decoding.
  * Its size is not a part of the public ABI, it must be allocated with
  * av_vda_alloc_context() and freed with av_free().
  */
 typedef struct AVVDAContext {
     /**
      * VDA decoder object. Created and freed by the caller.
      */
     VDADecoder decoder;
 
     /**
      * The output callback that must be passed to VDADecoderCreate.
      * Set by av_vda_alloc_context().
      */
     VDADecoderOutputCallback output_callback;
e7c5e17d
 
     /**
      * CVPixelBuffer Format Type that VDA will use for decoded frames; set by
      * the caller.
      */
     OSType cv_pix_fmt_type;
67afcefb
 } AVVDAContext;
 
 /**
  * Allocate and initialize a VDA context.
  *
  * This function should be called from the get_format() callback when the caller
  * selects the AV_PIX_FMT_VDA format. The caller must then create the decoder
  * object (using the output callback provided by libavcodec) that will be used
  * for VDA-accelerated decoding.
  *
  * When decoding with VDA is finished, the caller must destroy the decoder
  * object and free the VDA context using av_free().
  *
  * @return the newly allocated context or NULL on failure
  */
 AVVDAContext *av_vda_alloc_context(void);
 
 /**
  * This is a convenience function that creates and sets up the VDA context using
  * an internal implementation.
  *
  * @param avctx the corresponding codec context
  *
  * @return >= 0 on success, a negative AVERROR code on failure
  */
 int av_vda_default_init(AVCodecContext *avctx);
 
 /**
e7c5e17d
  * This is a convenience function that creates and sets up the VDA context using
  * an internal implementation.
  *
  * @param avctx the corresponding codec context
  * @param vdactx the VDA context to use
  *
  * @return >= 0 on success, a negative AVERROR code on failure
  */
 int av_vda_default_init2(AVCodecContext *avctx, AVVDAContext *vdactx);
 
 /**
67afcefb
  * This function must be called to free the VDA context initialized with
  * av_vda_default_init().
  *
  * @param avctx the corresponding codec context
  */
 void av_vda_default_free(AVCodecContext *avctx);
 
 /**
7c59b5c2
  * @}
  */
 
d66ee6ac
 #endif /* AVCODEC_VDA_H */