vp8cx.h 22.8 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
5
6
 *  that can be found in the LICENSE file in the root of the source
 *  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.
John Koleszar's avatar
John Koleszar committed
9
 */
James Zern's avatar
James Zern committed
10
11
#ifndef VPX_VP8CX_H_
#define VPX_VP8CX_H_
John Koleszar's avatar
John Koleszar committed
12

13
/*!\defgroup vp8_encoder WebM VP8/VP9 Encoder
John Koleszar's avatar
John Koleszar committed
14
15
16
17
 * \ingroup vp8
 *
 * @{
 */
18
#include "./vp8.h"
19
#include "./vpx_encoder.h"
John Koleszar's avatar
John Koleszar committed
20

James Zern's avatar
James Zern committed
21
/*!\file
22
 * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the
John Koleszar's avatar
John Koleszar committed
23
24
 *        vpx Codec Interface.
 */
25
26
27
28

#ifdef __cplusplus
extern "C" {
#endif
John Koleszar's avatar
John Koleszar committed
29

30
/*!\name Algorithm interface for VP8
John Koleszar's avatar
John Koleszar committed
31
 *
32
 * This interface provides the capability to encode raw VP8 streams.
33
 * @{
John Koleszar's avatar
John Koleszar committed
34
 */
35
extern vpx_codec_iface_t  vpx_codec_vp8_cx_algo;
John Koleszar's avatar
John Koleszar committed
36
extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
37
/*!@} - end algorithm interface member group*/
John Koleszar's avatar
John Koleszar committed
38

39
40
41
42
43
/*!\name Algorithm interface for VP9
 *
 * This interface provides the capability to encode raw VP9 streams.
 * @{
 */
44
45
extern vpx_codec_iface_t  vpx_codec_vp9_cx_algo;
extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
John Koleszar's avatar
John Koleszar committed
46
/*!@} - end algorithm interface member group*/
47
48


John Koleszar's avatar
John Koleszar committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Algorithm Flags
 */

/*!\brief Don't reference the last frame
 *
 * When this flag is set, the encoder will not use the last frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * last frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_LAST      (1<<16)


/*!\brief Don't reference the golden frame
 *
 * When this flag is set, the encoder will not use the golden frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * golden frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_GF        (1<<17)


/*!\brief Don't reference the alternate reference frame
 *
 * When this flag is set, the encoder will not use the alt ref frame as a
 * predictor. When not set, the encoder will choose whether to use the
 * alt ref frame or not automatically.
 */
#define VP8_EFLAG_NO_REF_ARF       (1<<21)


/*!\brief Don't update the last frame
 *
 * When this flag is set, the encoder will not update the last frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_LAST      (1<<18)


/*!\brief Don't update the golden frame
 *
 * When this flag is set, the encoder will not update the golden frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_GF        (1<<22)


/*!\brief Don't update the alternate reference frame
 *
 * When this flag is set, the encoder will not update the alt ref frame with
 * the contents of the current frame.
 */
#define VP8_EFLAG_NO_UPD_ARF       (1<<23)


/*!\brief Force golden frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the golden frame buffer.
 */
#define VP8_EFLAG_FORCE_GF         (1<<19)


/*!\brief Force alternate reference frame update
 *
 * When this flag is set, the encoder copy the contents of the current frame
 * to the alternate reference frame buffer.
 */
#define VP8_EFLAG_FORCE_ARF        (1<<24)


/*!\brief Disable entropy update
 *
 * When this flag is set, the encoder will not update its internal entropy
 * model based on the entropy of this frame.
 */
#define VP8_EFLAG_NO_UPD_ENTROPY   (1<<20)


128
/*!\brief VPx encoder control functions
John Koleszar's avatar
John Koleszar committed
129
 *
130
 * This set of macros define the control functions available for VPx
131
132
133
 * encoder interface.
 *
 * \sa #vpx_codec_control
John Koleszar's avatar
John Koleszar committed
134
 */
John Koleszar's avatar
John Koleszar committed
135
enum vp8e_enc_control_id {
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
  /*!\brief Codec control function to set mode of entropy update in encoder.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_UPD_ENTROPY           = 5,

  /*!\brief Codec control function to set reference update mode in encoder.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_UPD_REFERENCE,

  /*!\brief Codec control function to set which reference frame encoder can use.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_USE_REFERENCE,

  /*!\brief Codec control function to pass an ROI map to encoder.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ROI_MAP,

  /*!\brief Codec control function to pass an Active map to encoder.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ACTIVEMAP,

  /*!\brief Codec control function to set encoder scaling mode.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_SCALEMODE         = 11,

  /*!\brief Codec control function to set encoder internal speed settings.
John Koleszar's avatar
John Koleszar committed
173
174
175
176
177
   *
   * Changes in this value influences, among others, the encoder's selection
   * of motion estimation methods. Values greater than 0 will increase encoder
   * speed at the expense of quality.
   *
178
179
180
181
   * \note Valid range for VP8: -16..16
   * \note Valid range for VP9: -8..8
   *
   * Supported in codecs: VP8, VP9
John Koleszar's avatar
John Koleszar committed
182
183
   */
  VP8E_SET_CPUUSED           = 13,
184
185
186
187
188
189
190

  /*!\brief Codec control function to enable automatic set and use alf frames.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ENABLEAUTOALTREF,

191
192
193
194
  /*!\brief control function to set noise sensitivity
   *
   * 0: off, 1: OnYOnly, 2: OnYUV,
   * 3: OnYUVAggressive, 4: Adaptive
195
196
   *
   * Supported in codecs: VP8
197
198
   */
  VP8E_SET_NOISE_SENSITIVITY,
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247

  /*!\brief Codec control function to set sharpness.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_SHARPNESS,

  /*!\brief Codec control function to set the threshold for MBs treated static.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_STATIC_THRESHOLD,

  /*!\brief Codec control function to set the number of token partitions.
   *
   * Supported in codecs: VP8
   */
  VP8E_SET_TOKEN_PARTITIONS,

  /*!\brief Codec control function to get last quantizer chosen by the encoder.
   *
   * Return value uses internal quantizer scale defined by the codec.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_GET_LAST_QUANTIZER,

  /*!\brief Codec control function to get last quantizer chosen by the encoder.
   *
   * Return value uses the 0..63 scale as used by the rc_*_quantizer config
   * parameters.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_GET_LAST_QUANTIZER_64,

  /*!\brief Codec control function to set the max no of frames to create arf.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ARNR_MAXFRAMES,

  /*!\brief Codec control function to set the filter strength for the arf.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_ARNR_STRENGTH,

  /*!\deprecated control function to set the filter type to use for the arf. */
248
249
  VP8E_SET_ARNR_TYPE,

250
251
252
253
254
255
256
  /*!\brief Codec control function to set visual tuning.
   *
   * Supported in codecs: VP8, VP9
   */
  VP8E_SET_TUNING,

  /*!\brief Codec control function to set constrained quality level.
John Koleszar's avatar
John Koleszar committed
257
258
259
260
   *
   * \attention For this value to be used vpx_codec_enc_cfg_t::g_usage must be
   *            set to #VPX_CQ.
   * \note Valid range: 0..63
261
262
   *
   * Supported in codecs: VP8, VP9
John Koleszar's avatar
John Koleszar committed
263
264
265
   */
  VP8E_SET_CQ_LEVEL,

266
  /*!\brief Codec control function to set Max data rate for Intra frames.
John Koleszar's avatar
John Koleszar committed
267
268
269
270
271
272
273
274
275
276
   *
   * This value controls additional clamping on the maximum size of a
   * keyframe. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * unlimited, or no additional clamping beyond the codec's built-in
   * algorithm.
   *
   * For example, to allocate no more than 4.5 frames worth of bitrate
   * to a keyframe, set this to 450.
   *
277
   * Supported in codecs: VP8, VP9
John Koleszar's avatar
John Koleszar committed
278
279
   */
  VP8E_SET_MAX_INTRA_BITRATE_PCT,
John Koleszar's avatar
John Koleszar committed
280

281
282
283
284
285
286
287
  /*!\brief Codec control function to set reference and update frame flags.
   *
   *  Supported in codecs: VP8
   */
  VP8E_SET_FRAME_FLAGS,

  /*!\brief Codec control function to set max data rate for Inter frames.
288
289
290
291
292
293
294
295
296
297
   *
   * This value controls additional clamping on the maximum size of an
   * inter frame. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * unlimited, or no additional clamping beyond the codec's built-in
   * algorithm.
   *
   * For example, to allow no more than 4.5 frames worth of bitrate
   * to an inter frame, set this to 450.
   *
298
   * Supported in codecs: VP9
299
   */
300
  VP9E_SET_MAX_INTER_BITRATE_PCT,
301

302
  /*!\brief Boost percentage for Golden Frame in CBR mode.
303
304
305
306
307
308
309
310
311
312
   *
   * This value controls the amount of boost given to Golden Frame in
   * CBR mode. It is expressed as a percentage of the average
   * per-frame bitrate, with the special (and default) value 0 meaning
   * the feature is off, i.e., no golden frame boost in CBR mode and
   * average bitrate target is used.
   *
   * For example, to allow 100% more bits, i.e, 2X, in a golden frame
   * than average frame, set this to 100.
   *
313
   * Supported in codecs: VP9
314
   */
315
  VP9E_SET_GF_CBR_BOOST_PCT,
John Koleszar's avatar
John Koleszar committed
316

317
  /*!\brief Codec control function to set the temporal layer id.
Marco's avatar
Marco committed
318
319
320
321
322
   *
   * For temporal scalability: this control allows the application to set the
   * layer id for each frame to be encoded. Note that this control must be set
   * for every frame prior to encoding. The usage of this control function
   * supersedes the internal temporal pattern counter, which is now deprecated.
323
324
   *
   * Supported in codecs: VP8
Marco's avatar
Marco committed
325
326
327
   */
  VP8E_SET_TEMPORAL_LAYER_ID,

328
  /*!\brief Codec control function to set encoder screen content mode.
329
330
   *
   * 0: off, 1: On, 2: On with more aggressive rate control.
331
332
333
334
   *
   * Supported in codecs: VP8
   */
  VP8E_SET_SCREEN_CONTENT_MODE,
Marco's avatar
Marco committed
335

336
  /*!\brief Codec control function to set lossless encoding mode.
Yaowu Xu's avatar
Yaowu Xu committed
337
338
339
340
341
342
343
344
345
   *
   * VP9 can operate in lossless encoding mode, in which the bitstream
   * produced will be able to decode and reconstruct a perfect copy of
   * input source. This control function provides a mean to switch encoder
   * into lossless coding mode(1) or normal coding mode(0) that may be lossy.
   *                          0 = lossy coding mode
   *                          1 = lossless coding mode
   *
   *  By default, encoder operates in normal coding mode (maybe lossy).
346
347
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
348
   */
349
  VP9E_SET_LOSSLESS,
Yaowu Xu's avatar
Yaowu Xu committed
350

351
  /*!\brief Codec control function to set number of tile columns.
Yaowu Xu's avatar
Yaowu Xu committed
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
   *
   * In encoding and decoding, VP9 allows an input image frame be partitioned
   * into separated vertical tile columns, which can be encoded or decoded
   * independently. This enables easy implementation of parallel encoding and
   * decoding. This control requests the encoder to use column tiles in
   * encoding an input frame, with number of tile columns (in Log2 unit) as
   * the parameter:
   *             0 = 1 tile column
   *             1 = 2 tile columns
   *             2 = 4 tile columns
   *             .....
   *             n = 2**n tile columns
   * The requested tile columns will be capped by encoder based on image size
   * limitation (The minimum width of a tile column is 256 pixel, the maximum
   * is 4096).
   *
   * By default, the value is 0, i.e. one single column tile for entire image.
369
370
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
371
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
372
  VP9E_SET_TILE_COLUMNS,
Yaowu Xu's avatar
Yaowu Xu committed
373

374
  /*!\brief Codec control function to set number of tile rows.
Yaowu Xu's avatar
Yaowu Xu committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
   *
   * In encoding and decoding, VP9 allows an input image frame be partitioned
   * into separated horizontal tile rows. Tile rows are encoded or decoded
   * sequentially. Even though encoding/decoding of later tile rows depends on
   * earlier ones, this allows the encoder to output data packets for tile rows
   * prior to completely processing all tile rows in a frame, thereby reducing
   * the latency in processing between input and output. The parameter
   * for this control describes the number of tile rows, which has a valid
   * range [0, 2]:
   *            0 = 1 tile row
   *            1 = 2 tile rows
   *            2 = 4 tile rows
   *
   * By default, the value is 0, i.e. one single row tile for entire image.
389
390
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
391
   */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
392
  VP9E_SET_TILE_ROWS,
Yaowu Xu's avatar
Yaowu Xu committed
393

394
  /*!\brief Codec control function to enable frame parallel decoding feature.
Yaowu Xu's avatar
Yaowu Xu committed
395
396
397
398
399
400
401
402
   *
   * VP9 has a bitstream feature to reduce decoding dependency between frames
   * by turning off backward update of probability context used in encoding
   * and decoding. This allows staged parallel processing of more than one
   * video frames in the decoder. This control function provides a mean to
   * turn this feature on or off for bitstreams produced by encoder.
   *
   * By default, this feature is off.
403
404
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
405
   */
406
  VP9E_SET_FRAME_PARALLEL_DECODING,
Yaowu Xu's avatar
Yaowu Xu committed
407

408
  /*!\brief Codec control function to set adaptive quantization mode.
Yaowu Xu's avatar
Yaowu Xu committed
409
410
411
412
413
414
415
   *
   * VP9 has a segment based feature that allows encoder to adaptively change
   * quantization parameter for each segment within a frame to improve the
   * subjective quality. This control makes encoder operate in one of the
   * several AQ_modes supported.
   *
   * By default, encoder operates with AQ_Mode 0(adaptive quantization off).
416
417
   *
   * Supported in codecs: VP9
Yaowu Xu's avatar
Yaowu Xu committed
418
   */
419
  VP9E_SET_AQ_MODE,
420

421
  /*!\brief Codec control function to enable/disable periodic Q boost.
422
423
424
425
426
427
428
429
430
   *
   * One VP9 encoder speed feature is to enable quality boost by lowering
   * frame level Q periodically. This control function provides a mean to
   * turn on/off this feature.
   *               0 = off
   *               1 = on
   *
   * By default, the encoder is allowed to use this feature for appropriate
   * encoding modes.
431
432
   *
   * Supported in codecs: VP9
433
   */
434
  VP9E_SET_FRAME_PERIODIC_BOOST,
435

436
  /*!\brief Codec control function to set noise sensitivity.
437
   *
438
   *  0: off, 1: On(YOnly)
439
440
   *
   * Supported in codecs: VP9
441
442
   */
  VP9E_SET_NOISE_SENSITIVITY,
443

444
  /*!\brief Codec control function to turn on/off SVC in encoder.
445
446
447
   * \note Return value is VPX_CODEC_INVALID_PARAM if the encoder does not
   *       support SVC in its current encoding mode
   *  0: off, 1: on
448
449
   *
   * Supported in codecs: VP9
450
   */
451
  VP9E_SET_SVC,
452

453
  /*!\brief Codec control function to set parameters for SVC.
454
455
   * \note Parameters contain min_q, max_q, scaling factor for each of the
   *       SVC layers.
456
457
   *
   * Supported in codecs: VP9
458
   */
459
  VP9E_SET_SVC_PARAMETERS,
460

461
  /*!\brief Codec control function to set svc layer for spatial and temporal.
462
463
464
   * \note Valid ranges: 0..#vpx_codec_enc_cfg::ss_number_layers for spatial
   *                     layer and 0..#vpx_codec_enc_cfg::ts_number_layers for
   *                     temporal layer.
465
466
   *
   * Supported in codecs: VP9
467
   */
468
  VP9E_SET_SVC_LAYER_ID,
469

470
  /*!\brief Codec control function to set content type.
471
472
473
   * \note Valid parameter range:
   *              VP9E_CONTENT_DEFAULT = Regular video content (Default)
   *              VP9E_CONTENT_SCREEN  = Screen capture content
474
475
   *
   * Supported in codecs: VP9
476
   */
477
  VP9E_SET_TUNE_CONTENT,
478

479
  /*!\brief Codec control function to get svc layer ID.
480
481
   * \note The layer ID returned is for the data packet from the registered
   *       callback function.
482
483
   *
   * Supported in codecs: VP9
484
   */
485
  VP9E_GET_SVC_LAYER_ID,
486

487
  /*!\brief Codec control function to register callback to get per layer packet.
488
489
   * \note Parameter for this control function is a structure with a callback
   *       function and a pointer to private data used by the callback.
490
491
   *
   * Supported in codecs: VP9
492
   */
493
  VP9E_REGISTER_CX_CALLBACK,
494

495
  /*!\brief Codec control function to set color space info.
496
497
498
499
500
501
502
503
504
   * \note Valid ranges: 0..7, default is "UNKNOWN".
   *                     0 = UNKNOWN,
   *                     1 = BT_601
   *                     2 = BT_709
   *                     3 = SMPTE_170
   *                     4 = SMPTE_240
   *                     5 = BT_2020
   *                     6 = RESERVED
   *                     7 = SRGB
505
506
   *
   * Supported in codecs: VP9
507
508
   */
  VP9E_SET_COLOR_SPACE,
509

510
511
512
513
514
515
516
517
518
519
520
  /*!\brief Codec control function to set temporal layering mode.
   * \note Valid ranges: 0..3, default is "0" (VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING).
   *                     0 = VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING
   *                     1 = VP9E_TEMPORAL_LAYERING_MODE_BYPASS
   *                     2 = VP9E_TEMPORAL_LAYERING_MODE_0101
   *                     3 = VP9E_TEMPORAL_LAYERING_MODE_0212
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_TEMPORAL_LAYERING_MODE,

521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
  /*!\brief Codec control function to set minimum interval between GF/ARF frames
   *
   * By default the value is set as 4.
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_MIN_GF_INTERVAL,

  /*!\brief Codec control function to set minimum interval between GF/ARF frames
   *
   * By default the value is set as 16.
   *
   * Supported in codecs: VP9
   */
  VP9E_SET_MAX_GF_INTERVAL,

537
538
539
540
541
  /*!\brief Codec control function to get an Active map back from the encoder.
   *
   * Supported in codecs: VP9
   */
  VP9E_GET_ACTIVEMAP,
John Koleszar's avatar
John Koleszar committed
542
};
John Koleszar's avatar
John Koleszar committed
543
544
545
546
547

/*!\brief vpx 1-D scaling mode
 *
 * This set of constants define 1-D vpx scaling modes
 */
John Koleszar's avatar
John Koleszar committed
548
549
550
551
552
typedef enum vpx_scaling_mode_1d {
  VP8E_NORMAL      = 0,
  VP8E_FOURFIVE    = 1,
  VP8E_THREEFIVE   = 2,
  VP8E_ONETWO      = 3
John Koleszar's avatar
John Koleszar committed
553
554
} VPX_SCALING_MODE;

555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
/*!\brief Temporal layering mode enum for VP9 SVC.
 *
 * This set of macros define the different temporal layering modes.
 * Supported codecs: VP9 (in SVC mode)
 *
 */
typedef enum vp9e_temporal_layering_mode {
  /*!\brief No temporal layering.
   * Used when only spatial layering is used.
   */
  VP9E_TEMPORAL_LAYERING_MODE_NOLAYERING   = 0,

  /*!\brief Bypass mode.
   * Used when application needs to control temporal layering.
   * This will only work when the number of spatial layers equals 1.
   */
  VP9E_TEMPORAL_LAYERING_MODE_BYPASS       = 1,

  /*!\brief 0-1-0-1... temporal layering scheme with two temporal layers.
   */
  VP9E_TEMPORAL_LAYERING_MODE_0101         = 2,

  /*!\brief 0-2-1-2... temporal layering scheme with three temporal layers.
   */
  VP9E_TEMPORAL_LAYERING_MODE_0212         = 3
} VP9E_TEMPORAL_LAYERING_MODE;
John Koleszar's avatar
John Koleszar committed
581
582
583
584
585
586
587

/*!\brief  vpx region of interest map
 *
 * These defines the data structures for the region of interest map
 *
 */

John Koleszar's avatar
John Koleszar committed
588
typedef struct vpx_roi_map {
Adrian Grange's avatar
Adrian Grange committed
589
590
591
592
  /*! An id between 0 and 3 for each 16x16 region within a frame. */
  unsigned char *roi_map;
  unsigned int rows;       /**< Number of rows. */
  unsigned int cols;       /**< Number of columns. */
593
594
595
  // TODO(paulwilkins): broken for VP9 which has 8 segments
  // q and loop filter deltas for each segment
  // (see MAX_MB_SEGMENTS)
Adrian Grange's avatar
Adrian Grange committed
596
597
598
599
  int delta_q[4];          /**< Quantizer deltas. */
  int delta_lf[4];         /**< Loop filter deltas. */
  /*! Static breakout threshold for each segment. */
  unsigned int static_threshold[4];
John Koleszar's avatar
John Koleszar committed
600
601
602
603
604
605
606
607
608
} vpx_roi_map_t;

/*!\brief  vpx active region map
 *
 * These defines the data structures for active region map
 *
 */


John Koleszar's avatar
John Koleszar committed
609
610
611
612
typedef struct vpx_active_map {
  unsigned char  *active_map; /**< specify an on (1) or off (0) each 16x16 region within a frame */
  unsigned int    rows;       /**< number of rows */
  unsigned int    cols;       /**< number of cols */
John Koleszar's avatar
John Koleszar committed
613
614
615
616
617
618
619
} vpx_active_map_t;

/*!\brief  vpx image scaling mode
 *
 * This defines the data structure for image scaling mode
 *
 */
John Koleszar's avatar
John Koleszar committed
620
621
622
typedef struct vpx_scaling_mode {
  VPX_SCALING_MODE    h_scaling_mode;  /**< horizontal scaling mode */
  VPX_SCALING_MODE    v_scaling_mode;  /**< vertical scaling mode   */
John Koleszar's avatar
John Koleszar committed
623
624
625
626
627
} vpx_scaling_mode_t;

/*!\brief VP8 token partition mode
 *
 * This defines VP8 partitioning mode for compressed data, i.e., the number of
628
 * sub-streams in the bitstream. Used for parallelized decoding.
John Koleszar's avatar
John Koleszar committed
629
630
631
 *
 */

John Koleszar's avatar
John Koleszar committed
632
633
634
635
typedef enum {
  VP8_ONE_TOKENPARTITION   = 0,
  VP8_TWO_TOKENPARTITION   = 1,
  VP8_FOUR_TOKENPARTITION  = 2,
John Koleszar's avatar
John Koleszar committed
636
  VP8_EIGHT_TOKENPARTITION = 3
John Koleszar's avatar
John Koleszar committed
637
638
} vp8e_token_partitions;

639
640
641
642
643
644
/*!brief VP9 encoder content type */
typedef enum {
  VP9E_CONTENT_DEFAULT,
  VP9E_CONTENT_SCREEN,
  VP9E_CONTENT_INVALID
} vp9e_tune_content;
John Koleszar's avatar
John Koleszar committed
645

John Koleszar's avatar
John Koleszar committed
646
647
648
649
650
/*!\brief VP8 model tuning parameters
 *
 * Changes the encoder to tune for certain types of input material.
 *
 */
John Koleszar's avatar
John Koleszar committed
651
652
653
typedef enum {
  VP8_TUNE_PSNR,
  VP8_TUNE_SSIM
John Koleszar's avatar
John Koleszar committed
654
655
} vp8e_tuning;

656
657
658
659
660
661
662
/*!\brief  vp9 svc layer parameters
 *
 * This defines the spatial and temporal layer id numbers for svc encoding.
 * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
 * temporal layer id for the current frame.
 *
 */
663
typedef struct vpx_svc_layer_id {
664
665
  int spatial_layer_id;       /**< Spatial layer id number. */
  int temporal_layer_id;      /**< Temporal layer id number. */
666
667
} vpx_svc_layer_id_t;

John Koleszar's avatar
John Koleszar committed
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
/*!\brief VP8 encoder control function parameter type
 *
 * Defines the data types that VP8E control functions take. Note that
 * additional common controls are defined in vp8.h
 *
 */


/* These controls have been deprecated in favor of the flags parameter to
 * vpx_codec_encode(). See the definition of VP8_EFLAG_* above.
 */
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_ENTROPY,            int)
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_UPD_REFERENCE,          int)
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_USE_REFERENCE,          int)

Marco's avatar
Marco committed
683
684
VPX_CTRL_USE_TYPE(VP8E_SET_FRAME_FLAGS,        int)
VPX_CTRL_USE_TYPE(VP8E_SET_TEMPORAL_LAYER_ID,  int)
John Koleszar's avatar
John Koleszar committed
685
686
687
688
VPX_CTRL_USE_TYPE(VP8E_SET_ROI_MAP,            vpx_roi_map_t *)
VPX_CTRL_USE_TYPE(VP8E_SET_ACTIVEMAP,          vpx_active_map_t *)
VPX_CTRL_USE_TYPE(VP8E_SET_SCALEMODE,          vpx_scaling_mode_t *)

689
VPX_CTRL_USE_TYPE(VP9E_SET_SVC,                int)
690
VPX_CTRL_USE_TYPE(VP9E_SET_SVC_PARAMETERS,     void *)
691
VPX_CTRL_USE_TYPE(VP9E_REGISTER_CX_CALLBACK,   void *)
692
VPX_CTRL_USE_TYPE(VP9E_SET_SVC_LAYER_ID,       vpx_svc_layer_id_t *)
693

John Koleszar's avatar
John Koleszar committed
694
695
696
697
698
VPX_CTRL_USE_TYPE(VP8E_SET_CPUUSED,            int)
VPX_CTRL_USE_TYPE(VP8E_SET_ENABLEAUTOALTREF,   unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_NOISE_SENSITIVITY,  unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_SHARPNESS,          unsigned int)
VPX_CTRL_USE_TYPE(VP8E_SET_STATIC_THRESHOLD,   unsigned int)
John Koleszar's avatar
John Koleszar committed
699
VPX_CTRL_USE_TYPE(VP8E_SET_TOKEN_PARTITIONS,   int) /* vp8e_token_partitions */
John Koleszar's avatar
John Koleszar committed
700
701

VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_MAXFRAMES,     unsigned int)
John Koleszar's avatar
John Koleszar committed
702
VPX_CTRL_USE_TYPE(VP8E_SET_ARNR_STRENGTH,     unsigned int)
703
VPX_CTRL_USE_TYPE_DEPRECATED(VP8E_SET_ARNR_TYPE,     unsigned int)
John Koleszar's avatar
John Koleszar committed
704
VPX_CTRL_USE_TYPE(VP8E_SET_TUNING,             int) /* vp8e_tuning */
John Koleszar's avatar
John Koleszar committed
705
VPX_CTRL_USE_TYPE(VP8E_SET_CQ_LEVEL,      unsigned int)
John Koleszar's avatar
John Koleszar committed
706

707
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_COLUMNS,  int)
Ronald S. Bultje's avatar
Ronald S. Bultje committed
708
VPX_CTRL_USE_TYPE(VP9E_SET_TILE_ROWS,  int)
709

John Koleszar's avatar
John Koleszar committed
710
711
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER,     int *)
VPX_CTRL_USE_TYPE(VP8E_GET_LAST_QUANTIZER_64,  int *)
712
VPX_CTRL_USE_TYPE(VP9E_GET_SVC_LAYER_ID,  vpx_svc_layer_id_t *)
John Koleszar's avatar
John Koleszar committed
713

714
VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTRA_BITRATE_PCT, unsigned int)
715
VPX_CTRL_USE_TYPE(VP8E_SET_MAX_INTER_BITRATE_PCT, unsigned int)
716

Marco's avatar
Marco committed
717
718
VPX_CTRL_USE_TYPE(VP8E_SET_SCREEN_CONTENT_MODE, unsigned int)

719
720
VPX_CTRL_USE_TYPE(VP9E_SET_GF_CBR_BOOST_PCT, unsigned int)

John Koleszar's avatar
John Koleszar committed
721
VPX_CTRL_USE_TYPE(VP9E_SET_LOSSLESS, unsigned int)
722

723
VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PARALLEL_DECODING, unsigned int)
724

725
726
VPX_CTRL_USE_TYPE(VP9E_SET_AQ_MODE, unsigned int)

727
728
VPX_CTRL_USE_TYPE(VP9E_SET_FRAME_PERIODIC_BOOST, unsigned int)

729
730
VPX_CTRL_USE_TYPE(VP9E_SET_NOISE_SENSITIVITY,  unsigned int)

731
VPX_CTRL_USE_TYPE(VP9E_SET_TUNE_CONTENT, int) /* vp9e_tune_content */
732
733

VPX_CTRL_USE_TYPE(VP9E_SET_COLOR_SPACE, int)
734

735
736
737
738
VPX_CTRL_USE_TYPE(VP9E_SET_MIN_GF_INTERVAL,  unsigned int)

VPX_CTRL_USE_TYPE(VP9E_SET_MAX_GF_INTERVAL,  unsigned int)

739
VPX_CTRL_USE_TYPE(VP9E_GET_ACTIVEMAP, vpx_active_map_t *)
John Koleszar's avatar
John Koleszar committed
740
/*! @} - end defgroup vp8_encoder */
741
742
743
744
#ifdef __cplusplus
}  // extern "C"
#endif

James Zern's avatar
James Zern committed
745
#endif  // VPX_VP8CX_H_