ext/vpx/gstvp8enc.h

   1 /* VP8
   2  * Copyright (C) 2006 David Schleef <ds@schleef.org>
   3  * Copyright (C) 2010 Entropy Wave Inc
   4  * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  */
  22 #ifndef __GST_VP8_ENC_H__
  23 #define __GST_VP8_ENC_H__
  24
  25 #include <gst/gst.h>
  26 #include <gst/video/gstvideoencoder.h>
  27
  28 /* FIXME: Undef HAVE_CONFIG_H because vpx_codec.h uses it,
  29  * which causes compilation failures */
  30 #ifdef HAVE_CONFIG_H
  31 #undef HAVE_CONFIG_H
  32 #endif
  33
  34 #include <vpx/vpx_encoder.h>
  35 #include <vpx/vp8cx.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define GST_TYPE_VP8_ENC \
  40   (gst_vp8_enc_get_type())
  41 #define GST_VP8_ENC(obj) \
  42   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VP8_ENC,GstVP8Enc))
  43 #define GST_VP8_ENC_CLASS(klass) \
  44   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VP8_ENC,GstVP8EncClass))
  45 #define GST_IS_VP8_ENC(obj) \
  46   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VP8_ENC))
  47 #define GST_IS_VP8_ENC_CLASS(obj) \
  48   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VP8_ENC))
  49
  50 typedef struct _GstVP8Enc GstVP8Enc;
  51 typedef struct _GstVP8EncClass GstVP8EncClass;
  52
  53 struct _GstVP8Enc
  54 {
  55   GstVideoEncoder base_video_encoder;
  56
  57   /* < private > */
  58   vpx_codec_ctx_t encoder;
  59
  60   /* from downstream caps */
  61   int profile;
  62
  63   /* properties */
  64   /* Rate control options */
  65   enum vpx_rc_mode rc_end_usage;
  66   unsigned int rc_target_bitrate;
  67   gboolean rc_target_bitrate_set;
  68   unsigned int rc_min_quantizer, rc_max_quantizer;
  69
  70   unsigned int rc_dropframe_thresh;
  71   gboolean rc_resize_allowed;
  72   unsigned int rc_resize_up_thresh;
  73   unsigned int rc_resize_down_thresh;
  74   unsigned int rc_undershoot_pct;
  75   unsigned int rc_overshoot_pct;
  76   unsigned int rc_buf_sz;
  77   unsigned int rc_buf_initial_sz;
  78   unsigned int rc_buf_optimal_sz;
  79
  80   unsigned int rc_2pass_vbr_bias_pct;
  81   unsigned int rc_2pass_vbr_minsection_pct;
  82   unsigned int rc_2pass_vbr_maxsection_pct;
  83
  84   /* Global keyframe options */
  85   enum vpx_kf_mode kf_mode;
  86   unsigned int kf_max_dist;
  87
  88   /* Global two-pass options */
  89   enum vpx_enc_pass multipass_mode;
  90   gchar *multipass_cache_file;
  91   GByteArray *first_pass_cache_content;
  92   vpx_fixed_buf_t last_pass_cache_content;
  93
  94   /* Global temporal scalability options */
  95   unsigned int ts_number_layers;
  96   unsigned int ts_target_bitrate[VPX_TS_MAX_LAYERS];
  97   int n_ts_target_bitrate;
  98   unsigned int ts_rate_decimator[VPX_TS_MAX_LAYERS];
  99   int n_ts_rate_decimator;
 100   unsigned int ts_periodicity;
 101   unsigned int ts_layer_id[VPX_TS_MAX_PERIODICITY];
 102   int n_ts_layer_id;
 103
 104   /* Global, other options */
 105   vpx_codec_er_flags_t error_resilient;
 106   unsigned int lag_in_frames;
 107
 108   int threads;
 109 #if 0
 110   /* Only usage 0 is defined right now */
 111   int usage;
 112 #endif
 113
 114   /* Encode parameter */
 115   gint64 deadline;
 116
 117   /* Controls */
 118   VPX_SCALING_MODE h_scaling_mode;
 119   VPX_SCALING_MODE v_scaling_mode;
 120   int cpu_used;
 121   gboolean enable_auto_alt_ref;
 122   unsigned int noise_sensitivity;
 123   unsigned int sharpness;
 124   unsigned int static_threshold;
 125   vp8e_token_partitions token_partitions;
 126   unsigned int arnr_maxframes;
 127   unsigned int arnr_strength;
 128   unsigned int arnr_type;
 129   vp8e_tuning tuning;
 130   unsigned int cq_level;
 131   unsigned int max_intra_bitrate_pct;
 132
 133   /* state */
 134   gboolean inited;
 135
 136   vpx_image_t image;
 137
 138   int n_frames;
 139   int keyframe_distance;
 140
 141   GstVideoCodecState *input_state;
 142 };
 143
 144 struct _GstVP8EncClass
 145 {
 146   GstVideoEncoderClass base_video_encoder_class;
 147 };
 148
 149 GType gst_vp8_enc_get_type (void);
 150
 151 G_END_DECLS
 152
 153 #endif /* __GST_VP8_ENC_H__ */