SoftVPXEncoder.h revision 031be0f358b07732092a4d1bf02fc99f109a63c4
1/* 2 * Copyright (C) 2013 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef SOFT_VPX_ENCODER_H_ 18 19#define SOFT_VPX_ENCODER_H_ 20 21#include "SimpleSoftOMXComponent.h" 22 23#include <OMX_VideoExt.h> 24#include <OMX_IndexExt.h> 25 26#include <hardware/gralloc.h> 27 28#include "vpx/vpx_encoder.h" 29#include "vpx/vpx_codec.h" 30#include "vpx/vp8cx.h" 31 32namespace android { 33 34// Exposes a vpx encoder as an OMX Component 35// 36// Boilerplate for callback bindings are taken care 37// by the base class SimpleSoftOMXComponent and its 38// parent SoftOMXComponent. 39// 40// Only following encoder settings are available 41// - target bitrate 42// - rate control (constant / variable) 43// - frame rate 44// - error resilience 45// - token partitioning 46// - reconstruction & loop filters (g_profile) 47// 48// Only following color formats are recognized 49// - YUV420Planar 50// - YUV420SemiPlanar 51// - AndroidOpaque 52// 53// Following settings are not configurable by the client 54// - encoding deadline is realtime 55// - multithreaded encoding utilizes a number of threads equal 56// to online cpu's available 57// - the algorithm interface for encoder is vp8 58// - fractional bits of frame rate is discarded 59// - OMX timestamps are in microseconds, therefore 60// encoder timebase is fixed to 1/1000000 61 62struct SoftVPXEncoder : public SimpleSoftOMXComponent { 63 SoftVPXEncoder(const char *name, 64 const OMX_CALLBACKTYPE *callbacks, 65 OMX_PTR appData, 66 OMX_COMPONENTTYPE **component); 67 68protected: 69 virtual ~SoftVPXEncoder(); 70 71 // Returns current values for requested OMX 72 // parameters 73 virtual OMX_ERRORTYPE internalGetParameter( 74 OMX_INDEXTYPE index, OMX_PTR param); 75 76 // Validates, extracts and stores relevant OMX 77 // parameters 78 virtual OMX_ERRORTYPE internalSetParameter( 79 OMX_INDEXTYPE index, const OMX_PTR param); 80 81 virtual OMX_ERRORTYPE setConfig( 82 OMX_INDEXTYPE index, const OMX_PTR params); 83 84 // OMX callback when buffers available 85 // Note that both an input and output buffer 86 // is expected to be available to carry out 87 // encoding of the frame 88 virtual void onQueueFilled(OMX_U32 portIndex); 89 90 virtual OMX_ERRORTYPE getExtensionIndex( 91 const char *name, OMX_INDEXTYPE *index); 92 93private: 94 enum TemporalReferences { 95 // For 1 layer case: reference all (last, golden, and alt ref), but only 96 // update last. 97 kTemporalUpdateLastRefAll = 12, 98 // First base layer frame for 3 temporal layers, which updates last and 99 // golden with alt ref dependency. 100 kTemporalUpdateLastAndGoldenRefAltRef = 11, 101 // First enhancement layer with alt ref dependency. 102 kTemporalUpdateGoldenRefAltRef = 10, 103 // First enhancement layer with alt ref dependency. 104 kTemporalUpdateGoldenWithoutDependencyRefAltRef = 9, 105 // Base layer with alt ref dependency. 106 kTemporalUpdateLastRefAltRef = 8, 107 // Highest enhacement layer without dependency on golden with alt ref 108 // dependency. 109 kTemporalUpdateNoneNoRefGoldenRefAltRef = 7, 110 // Second layer and last frame in cycle, for 2 layers. 111 kTemporalUpdateNoneNoRefAltref = 6, 112 // Highest enhancement layer. 113 kTemporalUpdateNone = 5, 114 // Second enhancement layer. 115 kTemporalUpdateAltref = 4, 116 // Second enhancement layer without dependency on previous frames in 117 // the second enhancement layer. 118 kTemporalUpdateAltrefWithoutDependency = 3, 119 // First enhancement layer. 120 kTemporalUpdateGolden = 2, 121 // First enhancement layer without dependency on previous frames in 122 // the first enhancement layer. 123 kTemporalUpdateGoldenWithoutDependency = 1, 124 // Base layer. 125 kTemporalUpdateLast = 0, 126 }; 127 enum { 128 kMaxTemporalPattern = 8 129 }; 130 131 // number of buffers allocated per port 132 static const uint32_t kNumBuffers = 4; 133 134 // OMX port indexes that refer to input and 135 // output ports respectively 136 static const uint32_t kInputPortIndex = 0; 137 static const uint32_t kOutputPortIndex = 1; 138 139 // Byte-alignment required for buffers 140 static const uint32_t kInputBufferAlignment = 1; 141 static const uint32_t kOutputBufferAlignment = 2; 142 143 // Max value supported for DCT partitions 144 static const uint32_t kMaxDCTPartitions = 3; 145 146 // Number of supported input color formats 147 static const uint32_t kNumberOfSupportedColorFormats = 3; 148 149 // vpx specific opaque data structure that 150 // stores encoder state 151 vpx_codec_ctx_t* mCodecContext; 152 153 // vpx specific data structure that 154 // stores encoder configuration 155 vpx_codec_enc_cfg_t* mCodecConfiguration; 156 157 // vpx specific read-only data structure 158 // that specifies algorithm interface (e.g. vp8) 159 vpx_codec_iface_t* mCodecInterface; 160 161 // Width of the input frames 162 int32_t mWidth; 163 164 // Height of the input frames 165 int32_t mHeight; 166 167 // Target bitrate set for the encoder, in bits per second. 168 uint32_t mBitrate; 169 170 // Target framerate set for the encoder. 171 uint32_t mFramerate; 172 173 // If a request for a change it bitrate has been received. 174 bool mBitrateUpdated; 175 176 // Bitrate control mode, either constant or variable 177 vpx_rc_mode mBitrateControlMode; 178 179 // vp8 specific configuration parameter 180 // that enables token partitioning of 181 // the stream into substreams 182 int32_t mDCTPartitions; 183 184 // Parameter that denotes whether error resilience 185 // is enabled in encoder 186 OMX_BOOL mErrorResilience; 187 188 // Color format for the input port 189 OMX_COLOR_FORMATTYPE mColorFormat; 190 191 // Encoder profile corresponding to OMX level parameter 192 // 193 // The inconsistency in the naming is caused by 194 // OMX spec referring vpx profiles (g_profile) 195 // as "levels" whereas using the name "profile" for 196 // something else. 197 OMX_VIDEO_VP8LEVELTYPE mLevel; 198 199 // Key frame interval in frames 200 uint32_t mKeyFrameInterval; 201 202 // Minimum (best quality) quantizer 203 uint32_t mMinQuantizer; 204 205 // Maximum (worst quality) quantizer 206 uint32_t mMaxQuantizer; 207 208 // Number of coding temporal layers to be used. 209 size_t mTemporalLayers; 210 211 // Temporal layer bitrare ratio in percentage 212 uint32_t mTemporalLayerBitrateRatio[OMX_VIDEO_ANDROID_MAXVP8TEMPORALLAYERS]; 213 214 // Temporal pattern type 215 OMX_VIDEO_ANDROID_VPXTEMPORALLAYERPATTERNTYPE mTemporalPatternType; 216 217 // Temporal pattern length 218 size_t mTemporalPatternLength; 219 220 // Temporal pattern current index 221 size_t mTemporalPatternIdx; 222 223 // Frame type temporal pattern 224 TemporalReferences mTemporalPattern[kMaxTemporalPattern]; 225 226 // Last input buffer timestamp 227 OMX_TICKS mLastTimestamp; 228 229 // Conversion buffer is needed to convert semi 230 // planar yuv420 to planar format 231 // It is only allocated if input format is 232 // indeed YUV420SemiPlanar. 233 uint8_t* mConversionBuffer; 234 235 bool mInputDataIsMeta; 236 const hw_module_t *mGrallocModule; 237 238 bool mKeyFrameRequested; 239 240 // Initializes input and output OMX ports with sensible 241 // default values. 242 void initPorts(); 243 244 // Initializes vpx encoder with available settings. 245 status_t initEncoder(); 246 247 // Releases vpx encoder instance, with it's associated 248 // data structures. 249 // 250 // Unless called earlier, this is handled by the 251 // dtor. 252 status_t releaseEncoder(); 253 254 // Get current encode flags 255 vpx_enc_frame_flags_t getEncodeFlags(); 256 257 // Handles port changes with respect to color formats 258 OMX_ERRORTYPE internalSetFormatParams( 259 const OMX_VIDEO_PARAM_PORTFORMATTYPE* format); 260 261 // Verifies the component role tried to be set to this OMX component is 262 // strictly video_encoder.vp8 263 OMX_ERRORTYPE internalSetRoleParams( 264 const OMX_PARAM_COMPONENTROLETYPE* role); 265 266 // Updates bitrate to reflect port settings. 267 OMX_ERRORTYPE internalSetBitrateParams( 268 const OMX_VIDEO_PARAM_BITRATETYPE* bitrate); 269 270 // Handles port definition changes. 271 OMX_ERRORTYPE internalSetPortParams( 272 const OMX_PARAM_PORTDEFINITIONTYPE* port); 273 274 // Handles vp8 specific parameters. 275 OMX_ERRORTYPE internalSetVp8Params( 276 const OMX_VIDEO_PARAM_VP8TYPE* vp8Params); 277 278 // Handles Android vp8 specific parameters. 279 OMX_ERRORTYPE internalSetAndroidVp8Params( 280 const OMX_VIDEO_PARAM_ANDROID_VP8ENCODERTYPE* vp8AndroidParams); 281 282 // Updates encoder profile 283 OMX_ERRORTYPE internalSetProfileLevel( 284 const OMX_VIDEO_PARAM_PROFILELEVELTYPE* profileAndLevel); 285 286 DISALLOW_EVIL_CONSTRUCTORS(SoftVPXEncoder); 287}; 288 289} // namespace android 290 291#endif // SOFT_VPX_ENCODER_H_ 292