1/*
2 *  Copyright (c) 2010 The WebM 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#ifndef VPX_VP8CX_H_
11#define VPX_VP8CX_H_
12
13/*!\defgroup vp8_encoder WebM VP8/VP9 Encoder
14 * \ingroup vp8
15 *
16 * @{
17 */
18#include "./vp8.h"
19#include "./vpx_encoder.h"
20
21/*!\file
22 * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the
23 *        vpx Codec Interface.
24 */
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*!\name Algorithm interface for VP8
31 *
32 * This interface provides the capability to encode raw VP8 streams.
33 * @{
34 */
35extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
36extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
37/*!@} - end algorithm interface member group*/
38
39/*!\name Algorithm interface for VP9
40 *
41 * This interface provides the capability to encode raw VP9 streams.
42 * @{
43 */
44extern vpx_codec_iface_t vpx_codec_vp9_cx_algo;
45extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
46/*!@} - end algorithm interface member group*/
47
48/*
49 * Algorithm Flags
50 */
51
52/*!\brief Don't reference the last frame
53 *
54 * When this flag is set, the encoder will not use the last frame as a
55 * predictor. When not set, the encoder will choose whether to use the
56 * last frame or not automatically.
57 */
58#define VP8_EFLAG_NO_REF_LAST (1 << 16)
59
60/*!\brief Don't reference the golden frame
61 *
62 * When this flag is set, the encoder will not use the golden frame as a
63 * predictor. When not set, the encoder will choose whether to use the
64 * golden frame or not automatically.
65 */
66#define VP8_EFLAG_NO_REF_GF (1 << 17)
67
68/*!\brief Don't reference the alternate reference frame
69 *
70 * When this flag is set, the encoder will not use the alt ref frame as a
71 * predictor. When not set, the encoder will choose whether to use the
72 * alt ref frame or not automatically.
73 */
74#define VP8_EFLAG_NO_REF_ARF (1 << 21)
75
76/*!\brief Don't update the last frame
77 *
78 * When this flag is set, the encoder will not update the last frame with
79 * the contents of the current frame.
80 */
81#define VP8_EFLAG_NO_UPD_LAST (1 << 18)
82
83/*!\brief Don't update the golden frame
84 *
85 * When this flag is set, the encoder will not update the golden frame with
86 * the contents of the current frame.
87 */
88#define VP8_EFLAG_NO_UPD_GF (1 << 22)
89
90/*!\brief Don't update the alternate reference frame
91 *
92 * When this flag is set, the encoder will not update the alt ref frame with
93 * the contents of the current frame.
94 */
95#define VP8_EFLAG_NO_UPD_ARF (1 << 23)
96
97/*!\brief Force golden frame update
98 *
99 * When this flag is set, the encoder copy the contents of the current frame
100 * to the golden frame buffer.
101 */
102#define VP8_EFLAG_FORCE_GF (1 << 19)
103
104/*!\brief Force alternate reference frame update
105 *
106 * When this flag is set, the encoder copy the contents of the current frame
107 * to the alternate reference frame buffer.
108 */
109#define VP8_EFLAG_FORCE_ARF (1 << 24)
110
111/*!\brief Disable entropy update
112 *
113 * When this flag is set, the encoder will not update its internal entropy
114 * model based on the entropy of this frame.
115 */
116#define VP8_EFLAG_NO_UPD_ENTROPY (1 << 20)
117
118/*!\brief VPx encoder control functions
119 *
120 * This set of macros define the control functions available for VPx
121 * encoder interface.
122 *
123 * \sa #vpx_codec_control
124 */
125enum vp8e_enc_control_id {
126  /*!\brief Codec control function to pass an ROI map to encoder.
127   *
128   * Supported in codecs: VP8, VP9
129   */
130  VP8E_SET_ROI_MAP = 8,
131
132  /*!\brief Codec control function to pass an Active map to encoder.
133   *
134   * Supported in codecs: VP8, VP9
135   */
136  VP8E_SET_ACTIVEMAP,
137
138  /*!\brief Codec control function to set encoder scaling mode.
139   *
140   * Supported in codecs: VP8, VP9
141   */
142  VP8E_SET_SCALEMODE = 11,
143
144  /*!\brief Codec control function to set encoder internal speed settings.
145   *
146   * Changes in this value influences, among others, the encoder's selection
147   * of motion estimation methods. Values greater than 0 will increase encoder
148   * speed at the expense of quality.
149   *
150   * \note Valid range for VP8: -16..16
151   * \note Valid range for VP9: -8..8
152   *
153   * Supported in codecs: VP8, VP9
154   */
155  VP8E_SET_CPUUSED = 13,
156
157  /*!\brief Codec control function to enable automatic set and use alf frames.
158   *
159   * Supported in codecs: VP8, VP9
160   */
161  VP8E_SET_ENABLEAUTOALTREF,
162
163  /*!\brief control function to set noise sensitivity
164   *
165   * 0: off, 1: OnYOnly, 2: OnYUV,
166   * 3: OnYUVAggressive, 4: Adaptive
167   *
168   * Supported in codecs: VP8
169   */
170  VP8E_SET_NOISE_SENSITIVITY,
171
172  /*!\brief Codec control function to set sharpness.
173   *
174   * Supported in codecs: VP8, VP9
175   */
176  VP8E_SET_SHARPNESS,
177
178  /*!\brief Codec control function to set the threshold for MBs treated static.
179   *
180   * Supported in codecs: VP8, VP9
181   */
182  VP8E_SET_STATIC_THRESHOLD,
183
184  /*!\brief Codec control function to set the number of token partitions.
185   *
186   * Supported in codecs: VP8
187   */
188  VP8E_SET_TOKEN_PARTITIONS,
189
190  /*!\brief Codec control function to get last quantizer chosen by the encoder.
191   *
192   * Return value uses internal quantizer scale defined by the codec.
193   *
194   * Supported in codecs: VP8, VP9
195   */
196  VP8E_GET_LAST_QUANTIZER,
197
198  /*!\brief Codec control function to get last quantizer chosen by the encoder.
199   *
200   * Return value uses the 0..63 scale as used by the rc_*_quantizer config
201   * parameters.
202   *
203   * Supported in codecs: VP8, VP9
204   */
205  VP8E_GET_LAST_QUANTIZER_64,
206
207  /*!\brief Codec control function to set the max no of frames to create arf.
208   *
209   * Supported in codecs: VP8, VP9
210   */
211  VP8E_SET_ARNR_MAXFRAMES,
212
213  /*!\brief Codec control function to set the filter strength for the arf.
214   *
215   * Supported in codecs: VP8, VP9
216   */
217  VP8E_SET_ARNR_STRENGTH,
218
219  /*!\deprecated control function to set the filter type to use for the arf. */
220  VP8E_SET_ARNR_TYPE,
221
222  /*!\brief Codec control function to set visual tuning.
223   *
224   * Supported in codecs: VP8, VP9
225   */
226  VP8E_SET_TUNING,
227
228  /*!\brief Codec control function to set constrained quality level.
229   *
230   * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
231   *            set to #VPX_CQ.
232   * \note Valid range: 0..63
233   *
234   * Supported in codecs: VP8, VP9
235   */
236  VP8E_SET_CQ_LEVEL,
237
238  /*!\brief Codec control function to set Max data rate for Intra frames.
239   *
240   * This value controls additional clamping on the maximum size of a
241   * keyframe. It is expressed as a percentage of the average
242   * per-frame bitrate, with the special (and default) value 0 meaning
243   * unlimited, or no additional clamping beyond the codec's built-in
244   * algorithm.
245   *
246   * For example, to allocate no more than 4.5 frames worth of bitrate
247   * to a keyframe, set this to 450.
248   *
249   * Supported in codecs: VP8, VP9
250   */
251  VP8E_SET_MAX_INTRA_BITRATE_PCT,
252
253  /*!\brief Codec control function to set reference and update frame flags.
254   *
255   *  Supported in codecs: VP8
256   */
257  VP8E_SET_FRAME_FLAGS,
258
259  /*!\brief Codec control function to set max data rate for Inter frames.
260   *
261   * This value controls additional clamping on the maximum size of an
262   * inter frame. It is expressed as a percentage of the average
263   * per-frame bitrate, with the special (and default) value 0 meaning
264   * unlimited, or no additional clamping beyond the codec's built-in
265   * algorithm.
266   *
267   * For example, to allow no more than 4.5 frames worth of bitrate
268   * to an inter frame, set this to 450.
269   *
270   * Supported in codecs: VP9
271   */
272  VP9E_SET_MAX_INTER_BITRATE_PCT,
273
274  /*!\brief Boost percentage for Golden Frame in CBR mode.
275   *
276   * This value controls the amount of boost given to Golden Frame in
277   * CBR mode. It is expressed as a percentage of the average
278   * per-frame bitrate, with the special (and default) value 0 meaning
279   * the feature is off, i.e., no golden frame boost in CBR mode and
280   * average bitrate target is used.
281   *
282   * For example, to allow 100% more bits, i.e, 2X, in a golden frame
283   * than average frame, set this to 100.
284   *
285   * Supported in codecs: VP9
286   */
287  VP9E_SET_GF_CBR_BOOST_PCT,
288
289  /*!\brief Codec control function to set the temporal layer id.
290   *
291   * For temporal scalability: this control allows the application to set the
292   * layer id for each frame to be encoded. Note that this control must be set
293   * for every frame prior to encoding. The usage of this control function
294   * supersedes the internal temporal pattern counter, which is now deprecated.
295   *
296   * Supported in codecs: VP8
297   */
298  VP8E_SET_TEMPORAL_LAYER_ID,
299
300  /*!\brief Codec control function to set encoder screen content mode.
301   *
302   * 0: off, 1: On, 2: On with more aggressive rate control.
303   *
304   * Supported in codecs: VP8
305   */
306  VP8E_SET_SCREEN_CONTENT_MODE,
307
308  /*!\brief Codec control function to set lossless encoding mode.
309   *
310   * VP9 can operate in lossless encoding mode, in which the bitstream
311   * produced will be able to decode and reconstruct a perfect copy of
312   * input source. This control function provides a mean to switch encoder
313   * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
314   *                          0 = lossy coding mode
315   *                          1 = lossless coding mode
316   *
317   *  By default, encoder operates in normal coding mode (maybe lossy).
318   *
319   * Supported in codecs: VP9
320   */
321  VP9E_SET_LOSSLESS,
322
323  /*!\brief Codec control function to set number of tile columns.
324   *
325   * In encoding and decoding, VP9 allows an input image frame be partitioned
326   * into separated vertical tile columns, which can be encoded or decoded
327   * independently. This enables easy implementation of parallel encoding and
328   * decoding. This control requests the encoder to use column tiles in
329   * encoding an input frame, with number of tile columns (in Log2 unit) as
330   * the parameter:
331   *             0 = 1 tile column
332   *             1 = 2 tile columns
333   *             2 = 4 tile columns
334   *             .....
335   *             n = 2**n tile columns
336   * The requested tile columns will be capped by the encoder based on image
337   * size limitations (The minimum width of a tile column is 256 pixels, the
338   * maximum is 4096).
339   *
340   * By default, the value is 6, i.e., the maximum number of tiles supported by
341   * the resolution.
342   *
343   * Supported in codecs: VP9
344   */
345  VP9E_SET_TILE_COLUMNS,
346
347  /*!\brief Codec control function to set number of tile rows.
348   *
349   * In encoding and decoding, VP9 allows an input image frame be partitioned
350   * into separated horizontal tile rows. Tile rows are encoded or decoded
351   * sequentially. Even though encoding/decoding of later tile rows depends on
352   * earlier ones, this allows the encoder to output data packets for tile rows
353   * prior to completely processing all tile rows in a frame, thereby reducing
354   * the latency in processing between input and output. The parameter
355   * for this control describes the number of tile rows, which has a valid
356   * range [0, 2]:
357   *            0 = 1 tile row
358   *            1 = 2 tile rows
359   *            2 = 4 tile rows
360   *
361   * By default, the value is 0, i.e. one single row tile for entire image.
362   *
363   * Supported in codecs: VP9
364   */
365  VP9E_SET_TILE_ROWS,
366
367  /*!\brief Codec control function to enable frame parallel decoding feature.
368   *
369   * VP9 has a bitstream feature to reduce decoding dependency between frames
370   * by turning off backward update of probability context used in encoding
371   * and decoding. This allows staged parallel processing of more than one
372   * video frame in the decoder. This control function provides a means to
373   * turn this feature on or off for bitstreams produced by encoder.
374   *
375   * By default, this feature is on.
376   *
377   * Supported in codecs: VP9
378   */
379  VP9E_SET_FRAME_PARALLEL_DECODING,
380
381  /*!\brief Codec control function to set adaptive quantization mode.
382   *
383   * VP9 has a segment based feature that allows encoder to adaptively change
384   * quantization parameter for each segment within a frame to improve the
385   * subjective quality. This control makes encoder operate in one of the
386   * several AQ_modes supported.
387   *
388   * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
389   *
390   * Supported in codecs: VP9
391   */
392  VP9E_SET_AQ_MODE,
393
394  /*!\brief Codec control function to enable/disable periodic Q boost.
395   *
396   * One VP9 encoder speed feature is to enable quality boost by lowering
397   * frame level Q periodically. This control function provides a mean to
398   * turn on/off this feature.
399   *               0 = off
400   *               1 = on
401   *
402   * By default, the encoder is allowed to use this feature for appropriate
403   * encoding modes.
404   *
405   * Supported in codecs: VP9
406   */
407  VP9E_SET_FRAME_PERIODIC_BOOST,
408
409  /*!\brief Codec control function to set noise sensitivity.
410   *
411   *  0: off, 1: On(YOnly), 2: For SVC only, on top two spatial layers(YOnly)
412   *
413   * Supported in codecs: VP9
414   */
415  VP9E_SET_NOISE_SENSITIVITY,
416
417  /*!\brief Codec control function to turn on/off SVC in encoder.
418   * \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not
419   *       support SVC in its current encoding mode
420   *  0: off, 1: on
421   *
422   * Supported in codecs: VP9
423   */
424  VP9E_SET_SVC,
425
426  /*!\brief Codec control function to set parameters for SVC.
427   * \note Parameters contain min_q, max_q, scaling factor for each of the
428   *       SVC layers.
429   *
430   * Supported in codecs: VP9
431   */
432  VP9E_SET_SVC_PARAMETERS,
433
434  /*!\brief Codec control function to set svc layer for spatial and temporal.
435   * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
436   *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
437   *                     temporal layer.
438   *
439   * Supported in codecs: VP9
440   */
441  VP9E_SET_SVC_LAYER_ID,
442
443  /*!\brief Codec control function to set content type.
444   * \note Valid parameter range:
445   *              VP9E_CONTENT_DEFAULT = Regular video content (Default)
446   *              VP9E_CONTENT_SCREEN  = Screen capture content
447   *              VP9E_CONTENT_FILM    = Film content: improves grain retention
448   *
449   * Supported in codecs: VP9
450   */
451  VP9E_SET_TUNE_CONTENT,
452
453  /*!\brief Codec control function to get svc layer ID.
454   * \note The layer ID returned is for the data packet from the registered
455   *       callback function.
456   *
457   * Supported in codecs: VP9
458   */
459  VP9E_GET_SVC_LAYER_ID,
460
461  /*!\brief Codec control function to register callback to get per layer packet.
462   * \note Parameter for this control function is a structure with a callback
463   *       function and a pointer to private data used by the callback.
464   *
465   * Supported in codecs: VP9
466   */
467  VP9E_REGISTER_CX_CALLBACK,
468
469  /*!\brief Codec control function to set color space info.
470   * \note Valid ranges: 0..7, default is "UNKNOWN".
471   *                     0 = UNKNOWN,
472   *                     1 = BT_601
473   *                     2 = BT_709
474   *                     3 = SMPTE_170
475   *                     4 = SMPTE_240
476   *                     5 = BT_2020
477   *                     6 = RESERVED
478   *                     7 = SRGB
479   *
480   * Supported in codecs: VP9
481   */
482  VP9E_SET_COLOR_SPACE,
483
484  /*!\brief Codec control function to set temporal layering mode.
485   * \note Valid ranges: 0..3, default is "0"
486   * (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING).
487   *                     0 = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
488   *                     1 = VP9E_TEMPORAL_LAYERING_MODE_BYPASS
489   *                     2 = VP9E_TEMPORAL_LAYERING_MODE_0101
490   *                     3 = VP9E_TEMPORAL_LAYERING_MODE_0212
491   *
492   * Supported in codecs: VP9
493   */
494  VP9E_SET_TEMPORAL_LAYERING_MODE,
495
496  /*!\brief Codec control function to set minimum interval between GF/ARF frames
497   *
498   * By default the value is set as 4.
499   *
500   * Supported in codecs: VP9
501   */
502  VP9E_SET_MIN_GF_INTERVAL,
503
504  /*!\brief Codec control function to set minimum interval between GF/ARF frames
505   *
506   * By default the value is set as 16.
507   *
508   * Supported in codecs: VP9
509   */
510  VP9E_SET_MAX_GF_INTERVAL,
511
512  /*!\brief Codec control function to get an Active map back from the encoder.
513   *
514   * Supported in codecs: VP9
515   */
516  VP9E_GET_ACTIVEMAP,
517
518  /*!\brief Codec control function to set color range bit.
519   * \note Valid ranges: 0..1, default is 0
520   *                     0 = Limited range (16..235 or HBD equivalent)
521   *                     1 = Full range (0..255 or HBD equivalent)
522   *
523   * Supported in codecs: VP9
524   */
525  VP9E_SET_COLOR_RANGE,
526
527  /*!\brief Codec control function to set the frame flags and buffer indices
528   * for spatial layers. The frame flags and buffer indices are set using the
529   * struct #vpx_svc_ref_frame_config defined below.
530   *
531   * Supported in codecs: VP9
532  */
533  VP9E_SET_SVC_REF_FRAME_CONFIG,
534
535  /*!\brief Codec control function to set intended rendering image size.
536   *
537   * By default, this is identical to the image size in pixels.
538   *
539   * Supported in codecs: VP9
540   */
541  VP9E_SET_RENDER_SIZE,
542
543  /*!\brief Codec control function to set target level.
544   *
545   * 255: off (default); 0: only keep level stats; 10: target for level 1.0;
546   * 11: target for level 1.1; ... 62: target for level 6.2
547   *
548   * Supported in codecs: VP9
549   */
550  VP9E_SET_TARGET_LEVEL,
551
552  /*!\brief Codec control function to set row level multi-threading.
553  *
554  * 0 : off, 1 : on
555  *
556  * Supported in codecs: VP9
557  */
558  VP9E_SET_ROW_MT,
559
560  /*!\brief Codec control function to get bitstream level.
561   *
562   * Supported in codecs: VP9
563   */
564  VP9E_GET_LEVEL,
565
566  /*!\brief Codec control function to enable/disable special mode for altref
567   *        adaptive quantization. You can use it with --aq-mode concurrently.
568   *
569   * Enable special adaptive quantization for altref frames based on their
570   * expected prediction quality for the future frames.
571   *
572   * Supported in codecs: VP9
573   */
574  VP9E_SET_ALT_REF_AQ,
575
576  /*!\brief Boost percentage for Golden Frame in CBR mode.
577    *
578    * This value controls the amount of boost given to Golden Frame in
579    * CBR mode. It is expressed as a percentage of the average
580    * per-frame bitrate, with the special (and default) value 0 meaning
581    * the feature is off, i.e., no golden frame boost in CBR mode and
582    * average bitrate target is used.
583    *
584    * For example, to allow 100% more bits, i.e, 2X, in a golden frame
585    * than average frame, set this to 100.
586    *
587    * Supported in codecs: VP8
588    */
589  VP8E_SET_GF_CBR_BOOST_PCT,
590
591  /*!\brief Codec control function to enable the extreme motion vector unit test
592   * in VP9. Please note that this is only used in motion vector unit test.
593   *
594   * 0 : off, 1 : MAX_EXTREME_MV, 2 : MIN_EXTREME_MV
595   *
596   * Supported in codecs: VP9
597   */
598  VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST,
599};
600
601/*!\brief vpx 1-D scaling mode
602 *
603 * This set of constants define 1-D vpx scaling modes
604 */
605typedef enum vpx_scaling_mode_1d {
606  VP8E_NORMAL = 0,
607  VP8E_FOURFIVE = 1,
608  VP8E_THREEFIVE = 2,
609  VP8E_ONETWO = 3
610} VPX_SCALING_MODE;
611
612/*!\brief Temporal layering mode enum for VP9 SVC.
613 *
614 * This set of macros define the different temporal layering modes.
615 * Supported codecs: VP9 (in SVC mode)
616 *
617 */
618typedef enum vp9e_temporal_layering_mode {
619  /*!\brief No temporal layering.
620   * Used when only spatial layering is used.
621   */
622  VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING = 0,
623
624  /*!\brief Bypass mode.
625   * Used when application needs to control temporal layering.
626   * This will only work when the number of spatial layers equals 1.
627   */
628  VP9E_TEMPORAL_LAYERING_MODE_BYPASS = 1,
629
630  /*!\brief 0-1-0-1... temporal layering scheme with two temporal layers.
631   */
632  VP9E_TEMPORAL_LAYERING_MODE_0101 = 2,
633
634  /*!\brief 0-2-1-2... temporal layering scheme with three temporal layers.
635   */
636  VP9E_TEMPORAL_LAYERING_MODE_0212 = 3
637} VP9E_TEMPORAL_LAYERING_MODE;
638
639/*!\brief  vpx region of interest map
640 *
641 * These defines the data structures for the region of interest map
642 *
643 */
644
645typedef struct vpx_roi_map {
646  /*! An id between 0 and 3 for each 16x16 region within a frame. */
647  unsigned char *roi_map;
648  unsigned int rows; /**< Number of rows. */
649  unsigned int cols; /**< Number of columns. */
650  // TODO(paulwilkins): broken for VP9 which has 8 segments
651  // q and loop filter deltas for each segment
652  // (see MAX_MB_SEGMENTS)
653  int delta_q[4];  /**< Quantizer deltas. */
654  int delta_lf[4]; /**< Loop filter deltas. */
655  /*! Static breakout threshold for each segment. */
656  unsigned int static_threshold[4];
657} vpx_roi_map_t;
658
659/*!\brief  vpx active region map
660 *
661 * These defines the data structures for active region map
662 *
663 */
664
665typedef struct vpx_active_map {
666  /*!\brief specify an on (1) or off (0) each 16x16 region within a frame */
667  unsigned char *active_map;
668  unsigned int rows; /**< number of rows */
669  unsigned int cols; /**< number of cols */
670} vpx_active_map_t;
671
672/*!\brief  vpx image scaling mode
673 *
674 * This defines the data structure for image scaling mode
675 *
676 */
677typedef struct vpx_scaling_mode {
678  VPX_SCALING_MODE h_scaling_mode; /**< horizontal scaling mode */
679  VPX_SCALING_MODE v_scaling_mode; /**< vertical scaling mode   */
680} vpx_scaling_mode_t;
681
682/*!\brief VP8 token partition mode
683 *
684 * This defines VP8 partitioning mode for compressed data, i.e., the number of
685 * sub-streams in the bitstream. Used for parallelized decoding.
686 *
687 */
688
689typedef enum {
690  VP8_ONE_TOKENPARTITION = 0,
691  VP8_TWO_TOKENPARTITION = 1,
692  VP8_FOUR_TOKENPARTITION = 2,
693  VP8_EIGHT_TOKENPARTITION = 3
694} vp8e_token_partitions;
695
696/*!brief VP9 encoder content type */
697typedef enum {
698  VP9E_CONTENT_DEFAULT,
699  VP9E_CONTENT_SCREEN,
700  VP9E_CONTENT_FILM,
701  VP9E_CONTENT_INVALID
702} vp9e_tune_content;
703
704/*!\brief VP8 model tuning parameters
705 *
706 * Changes the encoder to tune for certain types of input material.
707 *
708 */
709typedef enum { VP8_TUNE_PSNR, VP8_TUNE_SSIM } vp8e_tuning;
710
711/*!\brief  vp9 svc layer parameters
712 *
713 * This defines the spatial and temporal layer id numbers for svc encoding.
714 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
715 * temporal layer id for the current frame.
716 *
717 */
718typedef struct vpx_svc_layer_id {
719  int spatial_layer_id;  /**< Spatial layer id number. */
720  int temporal_layer_id; /**< Temporal layer id number. */
721} vpx_svc_layer_id_t;
722
723/*!\brief  vp9 svc frame flag parameters.
724 *
725 * This defines the frame flags and buffer indices for each spatial layer for
726 * svc encoding.
727 * This is used with the #VP9E_SET_SVC_REF_FRAME_CONFIG control to set frame
728 * flags and buffer indices for each spatial layer for the current (super)frame.
729 *
730 */
731typedef struct vpx_svc_ref_frame_config {
732  int frame_flags[VPX_TS_MAX_LAYERS]; /**< Frame flags. */
733  int lst_fb_idx[VPX_TS_MAX_LAYERS];  /**< Last buffer index. */
734  int gld_fb_idx[VPX_TS_MAX_LAYERS];  /**< Golden buffer index. */
735  int alt_fb_idx[VPX_TS_MAX_LAYERS];  /**< Altref buffer index. */
736} vpx_svc_ref_frame_config_t;
737
738/*!\cond */
739/*!\brief VP8 encoder control function parameter type
740 *
741 * Defines the data types that VP8E control functions take. Note that
742 * additional common controls are defined in vp8.h
743 *
744 */
745
746VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS, int)
747#define VPX_CTRL_VP8E_SET_FRAME_FLAGS
748VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID, int)
749#define VPX_CTRL_VP8E_SET_TEMPORAL_LAYER_ID
750VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP, vpx_roi_map_t *)
751#define VPX_CTRL_VP8E_SET_ROI_MAP
752VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP, vpx_active_map_t *)
753#define VPX_CTRL_VP8E_SET_ACTIVEMAP
754VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE, vpx_scaling_mode_t *)
755#define VPX_CTRL_VP8E_SET_SCALEMODE
756
757VPX_CTRL_USE_TYPE(VP9E_SET_SVC, int)
758#define VPX_CTRL_VP9E_SET_SVC
759VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS, void *)
760#define VPX_CTRL_VP9E_SET_SVC_PARAMETERS
761VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK, void *)
762#define VPX_CTRL_VP9E_REGISTER_CX_CALLBACK
763VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
764#define VPX_CTRL_VP9E_SET_SVC_LAYER_ID
765
766VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED, int)
767#define VPX_CTRL_VP8E_SET_CPUUSED
768VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF, unsigned int)
769#define VPX_CTRL_VP8E_SET_ENABLEAUTOALTREF
770VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY, unsigned int)
771#define VPX_CTRL_VP8E_SET_NOISE_SENSITIVITY
772VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS, unsigned int)
773#define VPX_CTRL_VP8E_SET_SHARPNESS
774VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD, unsigned int)
775#define VPX_CTRL_VP8E_SET_STATIC_THRESHOLD
776VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS, int) /* vp8e_token_partitions */
777#define VPX_CTRL_VP8E_SET_TOKEN_PARTITIONS
778
779VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES, unsigned int)
780#define VPX_CTRL_VP8E_SET_ARNR_MAXFRAMES
781VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH, unsigned int)
782#define VPX_CTRL_VP8E_SET_ARNR_STRENGTH
783VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE, unsigned int)
784#define VPX_CTRL_VP8E_SET_ARNR_TYPE
785VPX_CTRL_USE_TYPE(VP8E_SET_TUNING, int) /* vp8e_tuning */
786#define VPX_CTRL_VP8E_SET_TUNING
787VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL, unsigned int)
788#define VPX_CTRL_VP8E_SET_CQ_LEVEL
789
790VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS, int)
791#define VPX_CTRL_VP9E_SET_TILE_COLUMNS
792VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS, int)
793#define VPX_CTRL_VP9E_SET_TILE_ROWS
794
795VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER, int *)
796#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER
797VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64, int *)
798#define VPX_CTRL_VP8E_GET_LAST_QUANTIZER_64
799VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID, vpx_svc_layer_id_t *)
800#define VPX_CTRL_VP9E_GET_SVC_LAYER_ID
801
802VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
803#define VPX_CTRL_VP8E_SET_MAX_INTRA_BITRATE_PCT
804VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
805#define VPX_CTRL_VP8E_SET_MAX_INTER_BITRATE_PCT
806
807VPX_CTRL_USE_TYPE(VP8E_SET_GF_CBR_BOOST_PCT, unsigned int)
808#define VPX_CTRL_VP8E_SET_GF_CBR_BOOST_PCT
809
810VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)
811#define VPX_CTRL_VP8E_SET_SCREEN_CONTENT_MODE
812
813VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)
814#define VPX_CTRL_VP9E_SET_GF_CBR_BOOST_PCT
815
816VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
817#define VPX_CTRL_VP9E_SET_LOSSLESS
818
819VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
820#define VPX_CTRL_VP9E_SET_FRAME_PARALLEL_DECODING
821
822VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)
823#define VPX_CTRL_VP9E_SET_AQ_MODE
824
825VPX_CTRL_USE_TYPE(VP9E_SET_ALT_REF_AQ, int)
826#define VPX_CTRL_VP9E_SET_ALT_REF_AQ
827
828VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)
829#define VPX_CTRL_VP9E_SET_FRAME_PERIODIC_BOOST
830
831VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY, unsigned int)
832#define VPX_CTRL_VP9E_SET_NOISE_SENSITIVITY
833
834VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
835#define VPX_CTRL_VP9E_SET_TUNE_CONTENT
836
837VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
838#define VPX_CTRL_VP9E_SET_COLOR_SPACE
839
840VPX_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL, unsigned int)
841#define VPX_CTRL_VP9E_SET_MIN_GF_INTERVAL
842
843VPX_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL, unsigned int)
844#define VPX_CTRL_VP9E_SET_MAX_GF_INTERVAL
845
846VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *)
847#define VPX_CTRL_VP9E_GET_ACTIVEMAP
848
849VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_RANGE, int)
850#define VPX_CTRL_VP9E_SET_COLOR_RANGE
851
852VPX_CTRL_USE_TYPE(VP9E_SET_SVC_REF_FRAME_CONFIG, vpx_svc_ref_frame_config_t *)
853#define VPX_CTRL_VP9E_SET_SVC_REF_FRAME_CONFIG
854
855VPX_CTRL_USE_TYPE(VP9E_SET_RENDER_SIZE, int *)
856#define VPX_CTRL_VP9E_SET_RENDER_SIZE
857
858VPX_CTRL_USE_TYPE(VP9E_SET_TARGET_LEVEL, unsigned int)
859#define VPX_CTRL_VP9E_SET_TARGET_LEVEL
860
861VPX_CTRL_USE_TYPE(VP9E_SET_ROW_MT, unsigned int)
862#define VPX_CTRL_VP9E_SET_ROW_MT
863
864VPX_CTRL_USE_TYPE(VP9E_GET_LEVEL, int *)
865#define VPX_CTRL_VP9E_GET_LEVEL
866
867VPX_CTRL_USE_TYPE(VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST, unsigned int)
868#define VPX_CTRL_VP9E_ENABLE_MOTION_VECTOR_UNIT_TEST
869
870/*!\endcond */
871/*! @} - end defgroup vp8_encoder */
872#ifdef __cplusplus
873}  // extern "C"
874#endif
875
876#endif  // VPX_VP8CX_H_
877