x264.h 45.4 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
Fiona Glaser's avatar
Fiona Glaser committed
2
 * x264.h: x264 public header
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Anton Mitrofanov's avatar
Anton Mitrofanov committed
4
 * Copyright (C) 2003-2015 x264 project
Laurent Aimar's avatar
Laurent Aimar committed
5
6
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7
 *          Loren Merritt <lorenm@u.washington.edu>
Fiona Glaser's avatar
Fiona Glaser committed
8
 *          Fiona Glaser <fiona@x264.com>
Laurent Aimar's avatar
Laurent Aimar committed
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
Fiona Glaser's avatar
Fiona Glaser committed
23
24
25
 *
 * This program is also available under a commercial proprietary license.
 * For more information, contact us at licensing@x264.com.
Laurent Aimar's avatar
Laurent Aimar committed
26
27
 *****************************************************************************/

28
29
#ifndef X264_X264_H
#define X264_X264_H
Laurent Aimar's avatar
Laurent Aimar committed
30

Steven Walters's avatar
Steven Walters committed
31
#if !defined(_STDINT_H) && !defined(_STDINT_H_) && !defined(_STDINT_H_INCLUDED) && !defined(_STDINT) &&\
32
    !defined(_SYS_STDINT_H_) && !defined(_INTTYPES_H) && !defined(_INTTYPES_H_) && !defined(_INTTYPES)
Eric Petit's avatar
Eric Petit committed
33
34
35
36
37
# ifdef _MSC_VER
#  pragma message("You must include stdint.h or inttypes.h before x264.h")
# else
#  warning You must include stdint.h or inttypes.h before x264.h
# endif
38
39
#endif

Måns Rullgård's avatar
Måns Rullgård committed
40
41
#include <stdarg.h>

42
43
#include "x264_config.h"

44
#define X264_BUILD 146
45
46
47
48
49
50
51
52
53
54
55

/* Application developers planning to link against a shared library version of
 * libx264 from a Microsoft Visual Studio or similar development environment
 * will need to define X264_API_IMPORTS before including this header.
 * This clause does not apply to MinGW, similar development environments, or non
 * Windows platforms. */
#ifdef X264_API_IMPORTS
#define X264_API __declspec(dllimport)
#else
#define X264_API
#endif
Laurent Aimar's avatar
Laurent Aimar committed
56
57

/* x264_t:
58
 *      opaque handler for encoder */
Laurent Aimar's avatar
Laurent Aimar committed
59
60
typedef struct x264_t x264_t;

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
/****************************************************************************
 * NAL structure and functions
 ****************************************************************************/

enum nal_unit_type_e
{
    NAL_UNKNOWN     = 0,
    NAL_SLICE       = 1,
    NAL_SLICE_DPA   = 2,
    NAL_SLICE_DPB   = 3,
    NAL_SLICE_DPC   = 4,
    NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
    NAL_SEI         = 6,    /* ref_idc == 0 */
    NAL_SPS         = 7,
    NAL_PPS         = 8,
    NAL_AUD         = 9,
    NAL_FILLER      = 12,
    /* ref_idc == 0 for 6,9,10,11,12 */
};
enum nal_priority_e
{
    NAL_PRIORITY_DISPOSABLE = 0,
    NAL_PRIORITY_LOW        = 1,
    NAL_PRIORITY_HIGH       = 2,
    NAL_PRIORITY_HIGHEST    = 3,
};

/* The data within the payload is already NAL-encapsulated; the ref_idc and type
 * are merely in the struct for easy access by the calling application.
 * All data returned in an x264_nal_t, including the data in p_payload, is no longer
 * valid after the next call to x264_encoder_encode.  Thus it must be used or copied
 * before calling x264_encoder_encode or x264_encoder_headers again. */
typedef struct
{
    int i_ref_idc;  /* nal_priority_e */
    int i_type;     /* nal_unit_type_e */
    int b_long_startcode;
    int i_first_mb; /* If this NAL is a slice, the index of the first MB in the slice. */
    int i_last_mb;  /* If this NAL is a slice, the index of the last MB in the slice. */

Kieran Kunhya's avatar
Kieran Kunhya committed
101
    /* Size of payload (including any padding) in bytes. */
102
103
104
105
106
    int     i_payload;
    /* If param->b_annexb is set, Annex-B bytestream with startcode.
     * Otherwise, startcode is replaced with a 4-byte size.
     * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
    uint8_t *p_payload;
Kieran Kunhya's avatar
Kieran Kunhya committed
107
108
109

    /* Size of padding in bytes. */
    int i_padding;
110
111
} x264_nal_t;

Laurent Aimar's avatar
Laurent Aimar committed
112
/****************************************************************************
113
 * Encoder parameters
Laurent Aimar's avatar
Laurent Aimar committed
114
 ****************************************************************************/
115
116
117
118
119
120
/* CPU flags */

/* x86 */
#define X264_CPU_CMOV            0x0000001
#define X264_CPU_MMX             0x0000002
#define X264_CPU_MMX2            0x0000004  /* MMX2 aka MMXEXT aka ISSE */
121
#define X264_CPU_MMXEXT          X264_CPU_MMX2
122
123
124
125
126
127
#define X264_CPU_SSE             0x0000008
#define X264_CPU_SSE2            0x0000010
#define X264_CPU_SSE3            0x0000020
#define X264_CPU_SSSE3           0x0000040
#define X264_CPU_SSE4            0x0000080  /* SSE4.1 */
#define X264_CPU_SSE42           0x0000100  /* SSE4.2 */
128
129
130
131
#define X264_CPU_LZCNT           0x0000200  /* Phenom support for "leading zero count" instruction. */
#define X264_CPU_AVX             0x0000400  /* AVX support: requires OS support even if YMM registers aren't used. */
#define X264_CPU_XOP             0x0000800  /* AMD XOP */
#define X264_CPU_FMA4            0x0001000  /* AMD FMA4 */
132
133
#define X264_CPU_FMA3            0x0002000  /* FMA3 */
#define X264_CPU_AVX2            0x0004000  /* AVX2 */
134
135
#define X264_CPU_BMI1            0x0008000  /* BMI1 */
#define X264_CPU_BMI2            0x0010000  /* BMI2 */
136
/* x86 modifiers */
137
138
139
140
141
142
143
144
#define X264_CPU_CACHELINE_32    0x0020000  /* avoid memory loads that span the border between two cachelines */
#define X264_CPU_CACHELINE_64    0x0040000  /* 32/64 is the size of a cacheline in bytes */
#define X264_CPU_SSE2_IS_SLOW    0x0080000  /* avoid most SSE2 functions on Athlon64 */
#define X264_CPU_SSE2_IS_FAST    0x0100000  /* a few functions are only faster on Core2 and Phenom */
#define X264_CPU_SLOW_SHUFFLE    0x0200000  /* The Conroe has a slow shuffle unit (relative to overall SSE performance) */
#define X264_CPU_STACK_MOD4      0x0400000  /* if stack is only mod4 and not mod16 */
#define X264_CPU_SLOW_CTZ        0x0800000  /* BSR/BSF x86 instructions are really slow on some CPUs */
#define X264_CPU_SLOW_ATOM       0x1000000  /* The Atom is terrible: slow SSE unaligned loads, slow
145
146
147
148
                                             * SIMD multiplies, slow SIMD variable shifts, slow pshufb,
                                             * cacheline split penalties -- gather everything here that
                                             * isn't shared by other CPUs to avoid making half a dozen
                                             * new SLOW flags. */
149
150
#define X264_CPU_SLOW_PSHUFB     0x2000000  /* such as on the Intel Atom */
#define X264_CPU_SLOW_PALIGNR    0x4000000  /* such as on the AMD Bobcat */
151
152
153
154

/* PowerPC */
#define X264_CPU_ALTIVEC         0x0000001

155
/* ARM and AArch64 */
156
157
158
#define X264_CPU_ARMV6           0x0000001
#define X264_CPU_NEON            0x0000002  /* ARM NEON */
#define X264_CPU_FAST_NEON_MRC   0x0000004  /* Transfer from NEON to ARM register is fast (Cortex-A9) */
159
#define X264_CPU_ARMV8           0x0000008
160
161

/* Analyse flags */
Laurent Aimar's avatar
Laurent Aimar committed
162
#define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
163
#define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
Laurent Aimar's avatar
Laurent Aimar committed
164
165
#define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
#define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
166
167
#define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
#define X264_DIRECT_PRED_NONE        0
168
169
#define X264_DIRECT_PRED_SPATIAL     1
#define X264_DIRECT_PRED_TEMPORAL    2
Loren Merritt's avatar
Loren Merritt committed
170
#define X264_DIRECT_PRED_AUTO        3
171
172
#define X264_ME_DIA                  0
#define X264_ME_HEX                  1
173
174
#define X264_ME_UMH                  2
#define X264_ME_ESA                  3
175
#define X264_ME_TESA                 4
Loren Merritt's avatar
Loren Merritt committed
176
177
178
#define X264_CQM_FLAT                0
#define X264_CQM_JVT                 1
#define X264_CQM_CUSTOM              2
179
180
181
#define X264_RC_CQP                  0
#define X264_RC_CRF                  1
#define X264_RC_ABR                  2
Fiona Glaser's avatar
Fiona Glaser committed
182
#define X264_QP_AUTO                 0
183
#define X264_AQ_NONE                 0
184
#define X264_AQ_VARIANCE             1
Anton Mitrofanov's avatar
Anton Mitrofanov committed
185
#define X264_AQ_AUTOVARIANCE         2
186
#define X264_AQ_AUTOVARIANCE_BIASED  3
187
188
189
#define X264_B_ADAPT_NONE            0
#define X264_B_ADAPT_FAST            1
#define X264_B_ADAPT_TRELLIS         2
Dylan Yudaken's avatar
Dylan Yudaken committed
190
#define X264_WEIGHTP_NONE            0
191
#define X264_WEIGHTP_SIMPLE          1
Dylan Yudaken's avatar
Dylan Yudaken committed
192
#define X264_WEIGHTP_SMART           2
Lamont Alston's avatar
Lamont Alston committed
193
194
195
#define X264_B_PYRAMID_NONE          0
#define X264_B_PYRAMID_STRICT        1
#define X264_B_PYRAMID_NORMAL        2
Fiona Glaser's avatar
Fiona Glaser committed
196
#define X264_KEYINT_MIN_AUTO         0
197
#define X264_KEYINT_MAX_INFINITE     (1<<30)
198

Loren Merritt's avatar
Loren Merritt committed
199
static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
200
static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
Lamont Alston's avatar
Lamont Alston committed
201
static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
202
203
204
static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
static const char * const x264_fullrange_names[] = { "off", "on", 0 };
205
206
207
208
static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", "bt2020", 0 };
static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316",
                                                    "iec61966-2-4", "bt1361e", "iec61966-2-1", "bt2020-10", "bt2020-12", 0 };
static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", "bt2020nc", "bt2020c", 0 };
209
static const char * const x264_nal_hrd_names[] = { "none", "vbr", "cbr", 0 };
Loren Merritt's avatar
Loren Merritt committed
210

211
/* Colorspace type */
Laurent Aimar's avatar
Laurent Aimar committed
212
213
214
#define X264_CSP_MASK           0x00ff  /* */
#define X264_CSP_NONE           0x0000  /* Invalid mode     */
#define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
215
#define X264_CSP_YV12           0x0002  /* yvu 4:2:0 planar */
216
#define X264_CSP_NV12           0x0003  /* yuv 4:2:0, with one y plane and one packed u+v */
Henrik Gramner's avatar
Henrik Gramner committed
217
218
219
#define X264_CSP_I422           0x0004  /* yuv 4:2:2 planar */
#define X264_CSP_YV16           0x0005  /* yvu 4:2:2 planar */
#define X264_CSP_NV16           0x0006  /* yuv 4:2:2, with one y plane and one packed u+v */
James Weaver's avatar
James Weaver committed
220
221
222
223
224
225
226
#define X264_CSP_V210           0x0007  /* 10-bit yuv 4:2:2 packed in 32 */
#define X264_CSP_I444           0x0008  /* yuv 4:4:4 planar */
#define X264_CSP_YV24           0x0009  /* yvu 4:4:4 planar */
#define X264_CSP_BGR            0x000a  /* packed bgr 24bits   */
#define X264_CSP_BGRA           0x000b  /* packed bgr 32bits   */
#define X264_CSP_RGB            0x000c  /* packed rgb 24bits   */
#define X264_CSP_MAX            0x000d  /* end of list */
227
228
#define X264_CSP_VFLIP          0x1000  /* the csp is vertically flipped */
#define X264_CSP_HIGH_DEPTH     0x2000  /* the csp has a depth of 16 bits per pixel component */
Laurent Aimar's avatar
Laurent Aimar committed
229

230
/* Slice type */
Laurent Aimar's avatar
Laurent Aimar committed
231
232
233
234
#define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
#define X264_TYPE_IDR           0x0001
#define X264_TYPE_I             0x0002
#define X264_TYPE_P             0x0003
235
236
#define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
#define X264_TYPE_B             0x0005
Lamont Alston's avatar
Lamont Alston committed
237
#define X264_TYPE_KEYFRAME      0x0006  /* IDR or I depending on b_open_gop option */
238
239
#define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
#define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
Laurent Aimar's avatar
Laurent Aimar committed
240

241
/* Log level */
242
243
244
245
246
247
#define X264_LOG_NONE          (-1)
#define X264_LOG_ERROR          0
#define X264_LOG_WARNING        1
#define X264_LOG_INFO           2
#define X264_LOG_DEBUG          3

248
249
/* Threading */
#define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
250
#define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
251

252
253
254
255
256
/* HRD */
#define X264_NAL_HRD_NONE            0
#define X264_NAL_HRD_VBR             1
#define X264_NAL_HRD_CBR             2

257
258
259
/* Zones: override ratecontrol or other options for specific sections of the video.
 * See x264_encoder_reconfig() for which options can be changed.
 * If zones overlap, whichever comes later in the list takes precedence. */
Loren Merritt's avatar
Loren Merritt committed
260
261
typedef struct
{
262
263
    int i_start, i_end; /* range of frame numbers */
    int b_force_qp; /* whether to use qp vs bitrate factor */
Loren Merritt's avatar
Loren Merritt committed
264
265
    int i_qp;
    float f_bitrate_factor;
266
    struct x264_param_t *param;
Loren Merritt's avatar
Loren Merritt committed
267
268
} x264_zone_t;

269
typedef struct x264_param_t
Laurent Aimar's avatar
Laurent Aimar committed
270
271
272
{
    /* CPU flags */
    unsigned int cpu;
Fiona Glaser's avatar
Fiona Glaser committed
273
274
    int         i_threads;           /* encode multiple frames in parallel */
    int         i_lookahead_threads; /* multiple threads for lookahead analysis */
275
    int         b_sliced_threads;  /* Whether to use slice-based threading. */
Loren Merritt's avatar
Loren Merritt committed
276
    int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
277
    int         b_cpu_independent; /* force canonical behavior rather than cpu-dependent optimal algorithms */
Steven Walters's avatar
Steven Walters committed
278
    int         i_sync_lookahead; /* threaded lookahead buffer */
Laurent Aimar's avatar
Laurent Aimar committed
279
280
281
282

    /* Video Properties */
    int         i_width;
    int         i_height;
Henrik Gramner's avatar
Henrik Gramner committed
283
    int         i_csp;         /* CSP of encoded bitstream */
Loren Merritt's avatar
Loren Merritt committed
284
    int         i_level_idc;
285
    int         i_frame_total; /* number of frames to encode if known, else 0 */
Laurent Aimar's avatar
Laurent Aimar committed
286

287
288
289
290
291
292
293
294
    /* NAL HRD
     * Uses Buffering and Picture Timing SEIs to signal HRD
     * The HRD in H.264 was not designed with VFR in mind.
     * It is therefore not recommendeded to use NAL HRD with VFR.
     * Furthermore, reconfiguring the VBV (via x264_encoder_reconfig)
     * will currently generate invalid HRD. */
    int         i_nal_hrd;

Laurent Aimar's avatar
Laurent Aimar committed
295
296
297
298
299
    struct
    {
        /* they will be reduced to be 0 < x <= 65535 and prime */
        int         i_sar_height;
        int         i_sar_width;
300
301

        int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
Loren Merritt's avatar
Loren Merritt committed
302

303
304
305
306
307
308
309
        /* see h264 annex E for the values of the following */
        int         i_vidformat;
        int         b_fullrange;
        int         i_colorprim;
        int         i_transfer;
        int         i_colmatrix;
        int         i_chroma_loc;    /* both top & bottom */
Laurent Aimar's avatar
Laurent Aimar committed
310
311
312
313
    } vui;

    /* Bitstream parameters */
    int         i_frame_reference;  /* Maximum number of reference frames */
314
315
    int         i_dpb_size;         /* Force a DPB size larger than that implied by B-frames and reference frames.
                                     * Useful in combination with interactive error resilience. */
316
317
    int         i_keyint_max;       /* Force an IDR keyframe at this interval */
    int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
318
    int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
Fiona Glaser's avatar
Fiona Glaser committed
319
320
    int         b_intra_refresh;    /* Whether or not to use periodic intra refresh instead of IDR frames. */

Laurent Aimar's avatar
Laurent Aimar committed
321
    int         i_bframe;   /* how many b-frame between 2 references pictures */
322
    int         i_bframe_adaptive;
323
    int         i_bframe_bias;
324
    int         i_bframe_pyramid;   /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
325
326
    int         b_open_gop;
    int         b_bluray_compat;
327
    int         i_avcintra_class;
Laurent Aimar's avatar
Laurent Aimar committed
328
329
330
331
332
333
334
335

    int         b_deblocking_filter;
    int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
    int         i_deblocking_filter_beta;       /* [-6, 6]  idem */

    int         b_cabac;
    int         i_cabac_init_idc;

336
    int         b_interlaced;
337
    int         b_constrained_intra;
338

Loren Merritt's avatar
Loren Merritt committed
339
    int         i_cqm_preset;
Henrik Gramner's avatar
Henrik Gramner committed
340
    char        *psz_cqm_file;      /* filename (in UTF-8) of CQM file, JM format */
Loren Merritt's avatar
Loren Merritt committed
341
342
    uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
    uint8_t     cqm_4py[16];
Fiona Glaser's avatar
Fiona Glaser committed
343
    uint8_t     cqm_4ic[16];
Loren Merritt's avatar
Loren Merritt committed
344
345
346
    uint8_t     cqm_4pc[16];
    uint8_t     cqm_8iy[64];
    uint8_t     cqm_8py[64];
Fiona Glaser's avatar
Fiona Glaser committed
347
348
    uint8_t     cqm_8ic[64];
    uint8_t     cqm_8pc[64];
Laurent Aimar's avatar
Laurent Aimar committed
349

350
351
352
353
    /* Log */
    void        (*pf_log)( void *, int i_level, const char *psz, va_list );
    void        *p_log_private;
    int         i_log_level;
Fiona Glaser's avatar
Fiona Glaser committed
354
    int         b_full_recon;   /* fully reconstruct frames, even when not necessary for encoding.  Implied by psz_dump_yuv */
Henrik Gramner's avatar
Henrik Gramner committed
355
    char        *psz_dump_yuv;  /* filename (in UTF-8) for reconstructed frames */
356

Laurent Aimar's avatar
Laurent Aimar committed
357
358
359
    /* Encoder analyser parameters */
    struct
    {
360
361
362
363
        unsigned int intra;     /* intra partitions */
        unsigned int inter;     /* inter partitions */

        int          b_transform_8x8;
Dylan Yudaken's avatar
Dylan Yudaken committed
364
        int          i_weighted_pred; /* weighting for P-frames */
Loren Merritt's avatar
Loren Merritt committed
365
        int          b_weighted_bipred; /* implicit weighting for B-frames */
366
        int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
Loren Merritt's avatar
Loren Merritt committed
367
368
        int          i_chroma_qp_offset;

369
370
        int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
        int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
371
        int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
Loren Merritt's avatar
Loren Merritt committed
372
        int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
373
        int          i_subpel_refine; /* subpixel motion estimation quality */
Loren Merritt's avatar
Loren Merritt committed
374
        int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
Alex Wright's avatar
Alex Wright committed
375
        int          b_mixed_references; /* allow each mb partition to have its own reference number */
Loren Merritt's avatar
Loren Merritt committed
376
        int          i_trellis;  /* trellis RD quantization */
Loren Merritt's avatar
Loren Merritt committed
377
        int          b_fast_pskip; /* early SKIP detection on P-frames */
378
        int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
379
        int          i_noise_reduction; /* adaptive pseudo-deadzone */
380
381
        float        f_psy_rd; /* Psy RD strength */
        float        f_psy_trellis; /* Psy trellis strength */
Fiona Glaser's avatar
Fiona Glaser committed
382
        int          b_psy; /* Toggle all psy optimizations */
383

384
385
        int          b_mb_info;            /* Use input mb_info data in x264_picture_t */
        int          b_mb_info_update; /* Update the values in mb_info according to the results of encoding. */
386

387
        /* the deadzone size that will be used in luma quantization */
388
        int          i_luma_deadzone[2]; /* {inter, intra} */
389

390
391
        int          b_psnr;    /* compute and print PSNR stats */
        int          b_ssim;    /* compute and print SSIM stats */
Laurent Aimar's avatar
Laurent Aimar committed
392
393
    } analyse;

394
395
396
    /* Rate control parameters */
    struct
    {
397
398
        int         i_rc_method;    /* X264_RC_* */

Fiona Glaser's avatar
Fiona Glaser committed
399
        int         i_qp_constant;  /* 0 to (51 + 6*(x264_bit_depth-8)). 0=lossless */
400
401
402
403
404
        int         i_qp_min;       /* min allowed QP value */
        int         i_qp_max;       /* max allowed QP value */
        int         i_qp_step;      /* max QP step between frames */

        int         i_bitrate;
Loren Merritt's avatar
Loren Merritt committed
405
        float       f_rf_constant;  /* 1pass VBR, nominal QP */
Fiona Glaser's avatar
Fiona Glaser committed
406
        float       f_rf_constant_max;  /* In CRF mode, maximum CRF as caused by VBV */
Loren Merritt's avatar
Loren Merritt committed
407
408
409
        float       f_rate_tolerance;
        int         i_vbv_max_bitrate;
        int         i_vbv_buffer_size;
410
        float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
411
412
413
        float       f_ip_factor;
        float       f_pb_factor;

Fiona Glaser's avatar
Fiona Glaser committed
414
415
416
417
        /* VBV filler: force CBR VBV and use filler bytes to ensure hard-CBR.
         * Implied by NAL-HRD CBR. */
        int         b_filler;

418
419
        int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
        float       f_aq_strength;
Fiona Glaser's avatar
Fiona Glaser committed
420
421
        int         b_mb_tree;      /* Macroblock-tree ratecontrol. */
        int         i_lookahead;
422

423
424
        /* 2pass */
        int         b_stat_write;   /* Enable stat writing in psz_stat_out */
Henrik Gramner's avatar
Henrik Gramner committed
425
        char        *psz_stat_out;  /* output filename (in UTF-8) of the 2pass stats file */
426
        int         b_stat_read;    /* Read stat from psz_stat_in and use it */
Henrik Gramner's avatar
Henrik Gramner committed
427
        char        *psz_stat_in;   /* input filename (in UTF-8) of the 2pass stats file */
428

Loren Merritt's avatar
Loren Merritt committed
429
        /* 2pass params (same as ffmpeg ones) */
430
431
        float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
        float       f_qblur;        /* temporally blur quants */
Loren Merritt's avatar
Loren Merritt committed
432
        float       f_complexity_blur; /* temporally blur complexity */
Loren Merritt's avatar
Loren Merritt committed
433
        x264_zone_t *zones;         /* ratecontrol overrides */
Loren Merritt's avatar
Loren Merritt committed
434
        int         i_zones;        /* number of zone_t's */
435
        char        *psz_zones;     /* alternate method of specifying zones */
436
437
    } rc;

438
439
    /* Cropping Rectangle parameters: added to those implicitly defined by
       non-mod16 video resolutions. */
440
441
    struct
    {
442
443
444
445
446
447
        unsigned int i_left;
        unsigned int i_top;
        unsigned int i_right;
        unsigned int i_bottom;
    } crop_rect;

448
449
450
    /* frame packing arrangement flag */
    int i_frame_packing;

451
    /* Muxing parameters */
452
    int b_aud;                  /* generate access unit delimiters */
Loren Merritt's avatar
10l    
Loren Merritt committed
453
    int b_repeat_headers;       /* put SPS/PPS before each keyframe */
454
455
    int b_annexb;               /* if set, place start codes (4 bytes) before NAL units,
                                 * otherwise place size (4 bytes) before NAL units. */
456
    int i_sps_id;               /* SPS and PPS id number */
457
458
459
    int b_vfr_input;            /* VFR input.  If 1, use timebase and timestamps for ratecontrol purposes.
                                 * If 0, use fps only. */
    int b_pulldown;             /* use explicity set timebase for CFR */
460
461
462
463
    uint32_t i_fps_num;
    uint32_t i_fps_den;
    uint32_t i_timebase_num;    /* Timebase numerator */
    uint32_t i_timebase_den;    /* Timebase denominator */
464

465
466
467
468
469
470
471
472
473
474
475
476
477
478
    int b_tff;

    /* Pulldown:
     * The correct pic_struct must be passed with each input frame.
     * The input timebase should be the timebase corresponding to the output framerate. This should be constant.
     * e.g. for 3:2 pulldown timebase should be 1001/30000
     * The PTS passed with each frame must be the PTS of the frame after pulldown is applied.
     * Frame doubling and tripling require b_vfr_input set to zero (see H.264 Table D-1)
     *
     * Pulldown changes are not clearly defined in H.264. Therefore, it is the calling app's responsibility to manage this.
     */

    int b_pic_struct;

Kieran Kunhya's avatar
Kieran Kunhya committed
479
480
    /* Fake Interlaced.
     *
481
     * Used only when b_interlaced=0. Setting this flag makes it possible to flag the stream as PAFF interlaced yet
Kieran Kunhya's avatar
Kieran Kunhya committed
482
483
484
485
486
     * encode all frames progessively. It is useful for encoding 25p and 30p Blu-Ray streams.
     */

    int b_fake_interlaced;

487
488
489
490
491
    /* Don't optimize header parameters based on video content, e.g. ensure that splitting an input video, compressing
     * each part, and stitching them back together will result in identical SPS/PPS. This is necessary for stitching
     * with container formats that don't allow multiple SPS/PPS. */
    int b_stitchable;

Steve Borho's avatar
Steve Borho committed
492
493
494
    int b_opencl;            /* use OpenCL when available */
    int i_opencl_device;     /* specify count of GPU devices to skip, for CLI users */
    void *opencl_device_id;  /* pass explicit cl_device_id as void*, for API users */
Henrik Gramner's avatar
Henrik Gramner committed
495
    char *psz_clbin_file;    /* filename (in UTF-8) of the compiled OpenCL kernel cache file */
Steve Borho's avatar
Steve Borho committed
496

Fiona Glaser's avatar
Fiona Glaser committed
497
498
499
    /* Slicing parameters */
    int i_slice_max_size;    /* Max size per slice in bytes; includes estimated NAL overhead. */
    int i_slice_max_mbs;     /* Max number of MBs per slice; overrides i_slice_count. */
Fiona Glaser's avatar
Fiona Glaser committed
500
    int i_slice_min_mbs;     /* Min number of MBs per slice */
Fiona Glaser's avatar
Fiona Glaser committed
501
    int i_slice_count;       /* Number of slices per frame: forces rectangular slices. */
Fiona Glaser's avatar
Fiona Glaser committed
502
503
    int i_slice_count_max;   /* Absolute cap on slices per frame; stops applying slice-max-size
                              * and slice-max-mbs if this is reached. */
Fiona Glaser's avatar
Fiona Glaser committed
504

505
506
507
508
509
    /* Optional callback for freeing this x264_param_t when it is done being used.
     * Only used when the x264_param_t sits in memory for an indefinite period of time,
     * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
     * Not used when x264_encoder_reconfig is called directly. */
    void (*param_free)( void* );
510
511
512
513
514
515
516

    /* Optional low-level callback for low-latency encoding.  Called for each output NAL unit
     * immediately after the NAL unit is finished encoding.  This allows the calling application
     * to begin processing video data (e.g. by sending packets over a network) before the frame
     * is done encoding.
     *
     * This callback MUST do the following in order to work correctly:
Henrik Gramner's avatar
Henrik Gramner committed
517
     * 1) Have available an output buffer of at least size nal->i_payload*3/2 + 5 + 64.
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
     * 2) Call x264_nal_encode( h, dst, nal ), where dst is the output buffer.
     * After these steps, the content of nal is valid and can be used in the same way as if
     * the NAL unit were output by x264_encoder_encode.
     *
     * This does not need to be synchronous with the encoding process: the data pointed to
     * by nal (both before and after x264_nal_encode) will remain valid until the next
     * x264_encoder_encode call.  The callback must be re-entrant.
     *
     * This callback does not work with frame-based threads; threads must be disabled
     * or sliced-threads enabled.  This callback also does not work as one would expect
     * with HRD -- since the buffering period SEI cannot be calculated until the frame
     * is finished encoding, it will not be sent via this callback.
     *
     * Note also that the NALs are not necessarily returned in order when sliced threads is
     * enabled.  Accordingly, the variable i_first_mb and i_last_mb are available in
     * x264_nal_t to help the calling application reorder the slices if necessary.
     *
     * When this callback is enabled, x264_encoder_encode does not return valid NALs;
     * the calling application is expected to acquire all output NALs through the callback.
     *
     * It is generally sensible to combine this callback with a use of slice-max-mbs or
Fiona Glaser's avatar
Fiona Glaser committed
539
540
541
542
543
544
545
     * slice-max-size.
     *
     * The opaque pointer is the opaque pointer from the input frame associated with this
     * NAL unit. This helps distinguish between nalu_process calls from different sources,
     * e.g. if doing multiple encodes in one process.
     */
    void (*nalu_process) ( x264_t *h, x264_nal_t *nal, void *opaque );
Laurent Aimar's avatar
Laurent Aimar committed
546
547
} x264_param_t;

548
549
void x264_nal_encode( x264_t *h, uint8_t *dst, x264_nal_t *nal );

550
551
552
553
/****************************************************************************
 * H.264 level restriction information
 ****************************************************************************/

554
555
typedef struct
{
556
    int level_idc;
557
558
    int mbps;        /* max macroblock processing rate (macroblocks/sec) */
    int frame_size;  /* max frame size (macroblocks) */
559
    int dpb;         /* max decoded picture buffer (mbs) */
560
561
562
563
564
    int bitrate;     /* max bitrate (kbit/sec) */
    int cpb;         /* max vbv buffer (kbit) */
    int mv_range;    /* max vertical mv component range (pixels) */
    int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
    int slice_rate;  /* ?? */
Fiona Glaser's avatar
Fiona Glaser committed
565
    int mincr;       /* min compression ratio */
566
567
568
    int bipred8x8;   /* limit bipred to >=8x8 */
    int direct8x8;   /* limit b_direct to >=8x8 */
    int frame_only;  /* forbid interlacing */
569
570
571
} x264_level_t;

/* all of the levels defined in the standard, terminated by .level_idc=0 */
572
X264_API extern const x264_level_t x264_levels[];
573

574
575
576
577
/****************************************************************************
 * Basic parameter handling functions
 ****************************************************************************/

Laurent Aimar's avatar
Laurent Aimar committed
578
579
580
581
/* x264_param_default:
 *      fill x264_param_t with default values and do CPU detection */
void    x264_param_default( x264_param_t * );

582
/* x264_param_parse:
583
584
585
586
587
588
 *  set one parameter by name.
 *  returns 0 on success, or returns one of the following errors.
 *  note: BAD_VALUE occurs only if it can't even parse the value,
 *  numerical range is not checked until x264_encoder_open() or
 *  x264_encoder_reconfig().
 *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
589
590
591
592
#define X264_PARAM_BAD_NAME  (-1)
#define X264_PARAM_BAD_VALUE (-2)
int x264_param_parse( x264_param_t *, const char *name, const char *value );

Laurent Aimar's avatar
Laurent Aimar committed
593
/****************************************************************************
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 * Advanced parameter handling functions
 ****************************************************************************/

/* These functions expose the full power of x264's preset-tune-profile system for
 * easy adjustment of large numbers of internal parameters.
 *
 * In order to replicate x264CLI's option handling, these functions MUST be called
 * in the following order:
 * 1) x264_param_default_preset
 * 2) Custom user options (via param_parse or directly assigned variables)
 * 3) x264_param_apply_fastfirstpass
 * 4) x264_param_apply_profile
 *
 * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
 * or --slow-firstpass is set. */

/* x264_param_default_preset:
 *      The same as x264_param_default, but also use the passed preset and tune
 *      to modify the default settings.
 *      (either can be NULL, which implies no preset or no tune, respectively)
 *
 *      Currently available presets are, ordered from fastest to slowest: */
616
static const char * const x264_preset_names[] = { "ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };
617

618
619
620
621
622
623
624
/*      The presets can also be indexed numerically, as in:
 *      x264_param_default_preset( &param, "3", ... )
 *      with ultrafast mapping to "0" and placebo mapping to "9".  This mapping may
 *      of course change if new presets are added in between, but will always be
 *      ordered from fastest to slowest.
 *
 *      Warning: the speed of these presets scales dramatically.  Ultrafast is a full
625
626
627
 *      100 times faster than placebo!
 *
 *      Currently available tunings are: */
628
static const char * const x264_tune_names[] = { "film", "animation", "grain", "stillimage", "psnr", "ssim", "fastdecode", "zerolatency", 0 };
629
630
631

/*      Multiple tunings can be used if separated by a delimiter in ",./-+",
 *      however multiple psy tunings cannot be used.
632
 *      film, animation, grain, stillimage, psnr, and ssim are psy tunings.
633
634
635
636
637
 *
 *      returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
int     x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );

/* x264_param_apply_fastfirstpass:
Fiona Glaser's avatar
Fiona Glaser committed
638
 *      If first-pass mode is set (rc.b_stat_read == 0, rc.b_stat_write == 1),
639
640
641
642
643
644
645
 *      modify the encoder settings to disable options generally not useful on
 *      the first pass. */
void    x264_param_apply_fastfirstpass( x264_param_t * );

/* x264_param_apply_profile:
 *      Applies the restrictions of the given profile.
 *      Currently available profiles are, from most to least restrictive: */
Henrik Gramner's avatar
Henrik Gramner committed
646
static const char * const x264_profile_names[] = { "baseline", "main", "high", "high10", "high422", "high444", 0 };
647
648
649
650
651
652
653
654
655
656
657
658
659

/*      (can be NULL, in which case the function will do nothing)
 *
 *      Does NOT guarantee that the given profile will be used: if the restrictions
 *      of "High" are applied to settings that are already Baseline-compatible, the
 *      stream will remain baseline.  In short, it does not increase settings, only
 *      decrease them.
 *
 *      returns 0 on success, negative on failure (e.g. invalid profile name). */
int     x264_param_apply_profile( x264_param_t *, const char *profile );

/****************************************************************************
 * Picture structures and functions
Laurent Aimar's avatar
Laurent Aimar committed
660
 ****************************************************************************/
661

662
663
664
665
666
667
668
/* x264_bit_depth:
 *      Specifies the number of bits per pixel that x264 uses. This is also the
 *      bit depth that x264 encodes in. If this value is > 8, x264 will read
 *      two bytes of input data for each pixel sample, and expect the upper
 *      (16-x264_bit_depth) bits to be zero.
 *      Note: The flag X264_CSP_HIGH_DEPTH must be used to specify the
 *      colorspace depth as well. */
669
X264_API extern const int x264_bit_depth;
670

671
672
673
674
675
/* x264_chroma_format:
 *      Specifies the chroma formats that x264 supports encoding. When this
 *      value is non-zero, then it represents a X264_CSP_* that is the only
 *      chroma format that x264 supports encoding. If the value is 0 then
 *      there are no restrictions. */
676
X264_API extern const int x264_chroma_format;
677

678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
enum pic_struct_e
{
    PIC_STRUCT_AUTO              = 0, // automatically decide (default)
    PIC_STRUCT_PROGRESSIVE       = 1, // progressive frame
    // "TOP" and "BOTTOM" are not supported in x264 (PAFF only)
    PIC_STRUCT_TOP_BOTTOM        = 4, // top field followed by bottom
    PIC_STRUCT_BOTTOM_TOP        = 5, // bottom field followed by top
    PIC_STRUCT_TOP_BOTTOM_TOP    = 6, // top field, bottom field, top field repeated
    PIC_STRUCT_BOTTOM_TOP_BOTTOM = 7, // bottom field, top field, bottom field repeated
    PIC_STRUCT_DOUBLE            = 8, // double frame
    PIC_STRUCT_TRIPLE            = 9, // triple frame
};

typedef struct
{
    double cpb_initial_arrival_time;
    double cpb_final_arrival_time;
    double cpb_removal_time;

    double dpb_output_time;
} x264_hrd_t;

700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
/* Arbitrary user SEI:
 * Payload size is in bytes and the payload pointer must be valid.
 * Payload types and syntax can be found in Annex D of the H.264 Specification.
 * SEI payload alignment bits as described in Annex D must be included at the
 * end of the payload if needed.
 * The payload should not be NAL-encapsulated.
 * Payloads are written first in order of input, apart from in the case when HRD
 * is enabled where payloads are written after the Buffering Period SEI. */

typedef struct
{
    int payload_size;
    int payload_type;
    uint8_t *payload;
} x264_sei_payload_t;

typedef struct
{
    int num_payloads;
    x264_sei_payload_t *payloads;
    /* In: optional callback to free each payload AND x264_sei_payload_t when used. */
    void (*sei_free)( void* );
} x264_sei_t;

Laurent Aimar's avatar
Laurent Aimar committed
724
725
typedef struct
{
726
727
728
729
    int     i_csp;       /* Colorspace */
    int     i_plane;     /* Number of image planes */
    int     i_stride[4]; /* Strides for each plane */
    uint8_t *plane[4];   /* Pointers to each plane */
Laurent Aimar's avatar
Laurent Aimar committed
730
731
} x264_image_t;

732
733
typedef struct
{
734
735
736
737
738
739
740
    /* All arrays of data here are ordered as follows:
     * each array contains one offset per macroblock, in raster scan order.  In interlaced
     * mode, top-field MBs and bottom-field MBs are interleaved at the row level.
     * Macroblocks are 16x16 blocks of pixels (with respect to the luma plane).  For the
     * purposes of calculating the number of macroblocks, width and height are rounded up to
     * the nearest 16.  If in interlaced mode, height is rounded up to the nearest 32 instead. */

741
742
743
744
    /* In: an array of quantizer offsets to be applied to this image during encoding.
     *     These are added on top of the decisions made by x264.
     *     Offsets can be fractional; they are added before QPs are rounded to integer.
     *     Adaptive quantization must be enabled to use this feature.  Behavior if quant
745
     *     offsets differ between encoding passes is undefined. */
746
747
748
749
    float *quant_offsets;
    /* In: optional callback to free quant_offsets when used.
     *     Useful if one wants to use a different quant_offset array for each frame. */
    void (*quant_offsets_free)( void* );
750
751
752
753
754

    /* In: optional array of flags for each macroblock.
     *     Allows specifying additional information for the encoder such as which macroblocks
     *     remain unchanged.  Usable flags are listed below.
     *     x264_param_t.analyse.b_mb_info must be set to use this, since x264 needs to track
755
756
757
758
759
760
761
762
763
764
765
766
767
768
     *     extra data internally to make full use of this information.
     *
     * Out: if b_mb_info_update is set, x264 will update this array as a result of encoding.
     *
     *      For "MBINFO_CONSTANT", it will remove this flag on any macroblock whose decoded
     *      pixels have changed.  This can be useful for e.g. noting which areas of the
     *      frame need to actually be blitted. Note: this intentionally ignores the effects
     *      of deblocking for the current frame, which should be fine unless one needs exact
     *      pixel-perfect accuracy.
     *
     *      Results for MBINFO_CONSTANT are currently only set for P-frames, and are not
     *      guaranteed to enumerate all blocks which haven't changed.  (There may be false
     *      negatives, but no false positives.)
     */
769
770
771
772
773
774
775
776
    uint8_t *mb_info;
    /* In: optional callback to free mb_info when used. */
    void (*mb_info_free)( void* );

    /* The macroblock is constant and remains unchanged from the previous frame. */
    #define X264_MBINFO_CONSTANT   (1<<0)
    /* More flags may be added in the future. */

Fiona Glaser's avatar
Fiona Glaser committed
777
778
779
780
781
782
    /* Out: SSIM of the the frame luma (if x264_param_t.b_ssim is set) */
    double f_ssim;
    /* Out: Average PSNR of the frame (if x264_param_t.b_psnr is set) */
    double f_psnr_avg;
    /* Out: PSNR of Y, U, and V (if x264_param_t.b_psnr is set) */
    double f_psnr[3];
783
784
785

    /* Out: Average effective CRF of the encoded frame */
    double f_crf_avg;
786
787
} x264_image_properties_t;

Laurent Aimar's avatar
Laurent Aimar committed
788
789
typedef struct
{
790
791
792
793
794
    /* In: force picture type (if not auto)
     *     If x264 encoding parameters are violated in the forcing of picture types,
     *     x264 will correct the input picture type and log a warning.
     *     The quality of frametype decisions may suffer if a great deal of fine-grained
     *     mixing of auto and forced frametypes is done.
Laurent Aimar's avatar
Laurent Aimar committed
795
796
     * Out: type of the picture encoded */
    int     i_type;
Fiona Glaser's avatar
Fiona Glaser committed
797
    /* In: force quantizer for != X264_QP_AUTO */
Laurent Aimar's avatar
Laurent Aimar committed
798
    int     i_qpplus1;
Kieran Kunhya's avatar
Kieran Kunhya committed
799
    /* In: pic_struct, for pulldown/doubling/etc...used only if b_pic_struct=1.
800
801
     *     use pic_struct_e for pic_struct inputs
     * Out: pic_struct element associated with frame */
802
    int     i_pic_struct;
Fiona Glaser's avatar
Fiona Glaser committed
803
804
805
    /* Out: whether this frame is a keyframe.  Important when using modes that result in
     * SEI recovery points being used instead of IDR frames. */
    int     b_keyframe;
Laurent Aimar's avatar
Laurent Aimar committed
806
807
    /* In: user pts, Out: pts of encoded picture (user)*/
    int64_t i_pts;
808
    /* Out: frame dts. When the pts of the first frame is close to zero,
809
810
     *      initial frames may have a negative dts which must be dealt with by any muxer */
    int64_t i_dts;
811
812
813
814
815
816
817
    /* In: custom encoding parameters to be set from this frame forwards
           (in coded order, not display order). If NULL, continue using
           parameters from the previous frame.  Some parameters, such as
           aspect ratio, can only be changed per-GOP due to the limitations
           of H.264 itself; in this case, the caller must force an IDR frame
           if it needs the changed parameter to apply immediately. */
    x264_param_t *param;
Fiona Glaser's avatar
Fiona Glaser committed
818
819
820
821
    /* In: raw image data */
    /* Out: reconstructed image data.  x264 may skip part of the reconstruction process,
            e.g. deblocking, in frames where it isn't necessary.  To force complete
            reconstruction, at a small speed cost, set b_full_recon. */
Laurent Aimar's avatar
Laurent Aimar committed
822
    x264_image_t img;
Fiona Glaser's avatar
Fiona Glaser committed
823
824
    /* In: optional information to modify encoder decisions for this frame
     * Out: information about the encoded frame */
825
    x264_image_properties_t prop;
826
827
    /* Out: HRD timing information. Output only when i_nal_hrd is set. */
    x264_hrd_t hrd_timing;
828
829
    /* In: arbitrary user SEI (e.g subtitles, AFDs) */
    x264_sei_t extra_sei;
Kieran Kunhya's avatar
Kieran Kunhya committed
830
    /* private user data. copied from input to output frames. */
831
    void *opaque;
Laurent Aimar's avatar
Laurent Aimar committed
832
833
} x264_picture_t;

834
835
836
837
838
/* x264_picture_init:
 *  initialize an x264_picture_t.  Needs to be done if the calling application
 *  allocates its own x264_picture_t as opposed to using x264_picture_alloc. */
void x264_picture_init( x264_picture_t *pic );

Laurent Aimar's avatar
Laurent Aimar committed
839
/* x264_picture_alloc:
840
 *  alloc data for a picture. You must call x264_picture_clean on it.
841
 *  returns 0 on success, or -1 on malloc failure or invalid colorspace. */
842
int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
Laurent Aimar's avatar
Laurent Aimar committed
843
844
845
846
847
848
849

/* x264_picture_clean:
 *  free associated resource for a x264_picture_t allocated with
 *  x264_picture_alloc ONLY */
void x264_picture_clean( x264_picture_t *pic );

/****************************************************************************
850
 * Encoder functions
Laurent Aimar's avatar
Laurent Aimar committed
851
852
 ****************************************************************************/

853
854
855
856
857
858
859
/* Force a link error in the case of linking against an incompatible API version.
 * Glue #defines exist to force correct macro expansion; the final output of the macro
 * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
#define x264_encoder_glue1(x,y) x##y
#define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
#define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)

Laurent Aimar's avatar
Laurent Aimar committed
860
861
/* x264_encoder_open:
 *      create a new encoder handler, all parameters from x264_param_t are copied */
862
863
x264_t *x264_encoder_open( x264_param_t * );

864
/* x264_encoder_reconfig:
865
 *      various parameters from x264_param_t are copied.
866
867
 *      this takes effect immediately, on whichever frame is encoded next;
 *      due to delay, this may not be the next frame passed to encoder_encode.
868
 *      if the change should apply to some particular frame, use x264_picture_t->param instead.
869
 *      returns 0 on success, negative on parameter validation error.
870
871
872
873
874
875
876
 *      not all parameters can be changed; see the actual function for a detailed breakdown.
 *
 *      since not all parameters can be changed, moving from preset to preset may not always
 *      fully copy all relevant parameters, but should still work usably in practice. however,
 *      more so than for other presets, many of the speed shortcuts used in ultrafast cannot be
 *      switched out of; using reconfig to switch between ultrafast and other presets is not
 *      recommended without a more fine-grained breakdown of parameters to take this into account. */
877
int     x264_encoder_reconfig( x264_t *, x264_param_t * );
878
879
880
881
882
883
884
885
/* x264_encoder_parameters:
 *      copies the current internal set of parameters to the pointer provided
 *      by the caller.  useful when the calling application needs to know
 *      how x264_encoder_open has changed the parameters, or the current state
 *      of the encoder after multiple x264_encoder_reconfig calls.
 *      note that the data accessible through pointers in the returned param struct
 *      (e.g. filenames) should not be modified by the calling application. */
void    x264_encoder_parameters( x264_t *, x264_param_t * );
Laurent Aimar's avatar
Laurent Aimar committed
886
/* x264_encoder_headers:
887
 *      return the SPS and PPS that will be used for the whole stream.
888
 *      *pi_nal is the number of NAL units outputted in pp_nal.
Fiona Glaser's avatar
Fiona Glaser committed
889
 *      returns the number of bytes in the returned NALs.
890
891
 *      returns negative on error.
 *      the payloads of all output NALs are guaranteed to be sequential in memory. */
892
int     x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
Laurent Aimar's avatar
Laurent Aimar committed
893
/* x264_encoder_encode:
894
 *      encode one picture.
895
 *      *pi_nal is the number of NAL units outputted in pp_nal.
Fiona Glaser's avatar
Fiona Glaser committed
896
897
 *      returns the number of bytes in the returned NALs.
 *      returns negative on error and zero if no NAL units returned.
898
 *      the payloads of all output NALs are guaranteed to be sequential in memory. */
899
int     x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
Laurent Aimar's avatar
Laurent Aimar committed
900
901
902
/* x264_encoder_close:
 *      close an encoder handler */
void    x264_encoder_close  ( x264_t * );
903
904
905
906
/* x264_encoder_delayed_frames:
 *      return the number of currently delayed (buffered) frames
 *      this should be used at the end of the stream, to know when you have all the encoded frames. */
int     x264_encoder_delayed_frames( x264_t * );
907
908
909
910
/* x264_encoder_maximum_delayed_frames( x264_t *h ):
 *      return the maximum number of delayed (buffered) frames that can occur with the current
 *      parameters. */
int     x264_encoder_maximum_delayed_frames( x264_t *h );
911
912
913
914
/* x264_encoder_intra_refresh:
 *      If an intra refresh is not in progress, begin one with the next P-frame.
 *      If an intra refresh is in progress, begin one as soon as the current one finishes.
 *      Requires that b_intra_refresh be set.
915
 *
916
917
 *      Useful for interactive streaming where the client can tell the server that packet loss has
 *      occurred.  In this case, keyint can be set to an extremely high value so that intra refreshes
918
919
920
921
922
923
 *      only occur when calling x264_encoder_intra_refresh.
 *
 *      In multi-pass encoding, if x264_encoder_intra_refresh is called differently in each pass,
 *      behavior is undefined.
 *
 *      Should not be called during an x264_encoder_encode. */
924
void    x264_encoder_intra_refresh( x264_t * );
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
/* x264_encoder_invalidate_reference:
 *      An interactive error resilience tool, designed for use in a low-latency one-encoder-few-clients
 *      system.  When the client has packet loss or otherwise incorrectly decodes a frame, the encoder
 *      can be told with this command to "forget" the frame and all frames that depend on it, referencing
 *      only frames that occurred before the loss.  This will force a keyframe if no frames are left to
 *      reference after the aforementioned "forgetting".
 *
 *      It is strongly recommended to use a large i_dpb_size in this case, which allows the encoder to
 *      keep around extra, older frames to fall back on in case more recent frames are all invalidated.
 *      Unlike increasing i_frame_reference, this does not increase the number of frames used for motion
 *      estimation and thus has no speed impact.  It is also recommended to set a very large keyframe
 *      interval, so that keyframes are not used except as necessary for error recovery.
 *
 *      x264_encoder_invalidate_reference is not currently compatible with the use of B-frames or intra
 *      refresh.
 *
 *      In multi-pass encoding, if x264_encoder_invalidate_reference is called differently in each pass,
 *      behavior is undefined.
 *
944
 *      Should not be called during an x264_encoder_encode, but multiple calls can be made simultaneously.
945
946
947
 *
 *      Returns 0 on success, negative on failure. */
int x264_encoder_invalidate_reference( x264_t *, int64_t pts );
Laurent Aimar's avatar
Laurent Aimar committed
948
949

#endif