LICENSE: update with latest text
[profile/ivi/libvpx.git] / vpx / vp8e.h
1 /*
2  *  Copyright (c) 2010 The VP8 project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license 
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may 
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10
11
12 /* This file contains backwards compatibility stubs for applications using
13  * the VP8 version 1.0 API.
14  */
15 #ifndef VP8E_H
16 #define VP8E_H
17 #include "vpx/vpx_codec_impl_top.h"
18
19 #if defined(VPX_CODEC_DISABLE_COMPAT) && VPX_CODEC_DISABLE_COMPAT
20 #error "Backwards compatibility disabled: don't include vp8e.h"
21 #endif
22
23 #include "vp8cx.h"
24 DECLSPEC_DEPRECATED extern vpx_codec_iface_t vpx_enc_vp8_algo DEPRECATED;
25
26
27 enum
28 {
29     VP8E_SET_REFERENCE     = VP8_SET_REFERENCE,
30     VP8E_COPY_REFERENCE    = VP8_COPY_REFERENCE,
31     VP8E_SET_PREVIEWPP     = VP8_SET_POSTPROC,
32     VP8E_SET_FLUSHFLAG     = 4,
33     VP8E_SET_FRAMETYPE     = 10,
34     VP8E_SET_ENCODING_MODE = 12
35 };
36
37 #define NORMAL_FRAME   (0)
38 #define KEY_FRAME      (1)
39
40 /* Change VP8E to VP8 to get the undeprecated version of these (defined in
41  * vp8.h)
42  */
43 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_REFERENCE,   vpx_ref_frame_t *)
44 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_COPY_REFERENCE,  vpx_ref_frame_t *)
45 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_PREVIEWPP,   vp8_postproc_cfg_t *)
46
47
48 /* Flush is done by calling vpx_codec_encode with a NULL input image. */
49 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_FLUSHFLAG,          int)
50
51
52 /* Frame type is set with a flag to vpx_codec_control. See VPX_EFLAG_FORCE_KF
53  */
54 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_FRAMETYPE,          int)
55
56
57 /* This control has been deprecated in favor of the duration parameter to
58  * vpx_codec_encode(). Use the #VPX_DL_REALTIME, #VPX_DL_GOOD_QUALITY,
59  * #VPX_DL_BEST_QUALITY constants to that parameter instead.
60  */
61 VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ENCODING_MODE, vp8e_encoding_mode)
62 #include "vpx/vpx_codec_impl_bottom.h"
63 #endif