aboutsummaryrefslogblamecommitdiffstats
path: root/src/lib/ffmpeg-2.1/libavutil/frame.pas
blob: 4a7150cf2842ffbf81f36dae69d8f76042be3696 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
128
129
130
131
132
133
134
135
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
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
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733




























































































































































































































































































































































































































































































































































































































































































































































                                                                                                                                     
(*
 * AVOptions
 * copyright (c) 2005 Michael Niedermayer <michaelni@gmx.at>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * This is a part of Pascal porting of ffmpeg.
 * - Originally by Victor Zinetz for Delphi and Free Pascal on Windows.
 * - For Mac OS X, some modifications were made by The Creative CAT, denoted as CAT
 *   in the source codes.
 * - Changes and updates by the UltraStar Deluxe Team
 *
 * Conversion of libavutil/frame.h
 * avutil version 52.48.100
 *
*)

const
  AV_NUM_DATA_POINTERS = 8;

  FF_DECODE_ERROR_INVALID_BITSTREAM = 1;
  FF_DECODE_ERROR_MISSING_REFERENCE = 2;


type
  TAVColorSpace = (
    AVCOL_SPC_RGB         = 0,
    AVCOL_SPC_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
    AVCOL_SPC_UNSPECIFIED = 2,
    AVCOL_SPC_FCC         = 4,
    AVCOL_SPC_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
    AVCOL_SPC_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
    AVCOL_SPC_SMPTE240M_  = 7,
    AVCOL_SPC_YCGCO       = 8,
    AVCOL_SPC_NB               ///< Not part of ABI
  );

  TAVColorRange = (
    AVCOL_RANGE_UNSPECIFIED = 0,
    AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
    AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
    AVCOL_RANGE_NB               ///< Not part of ABI
  );

  TAVFrameSideDataType = (
    (**
     * The data is the AVPanScan struct defined in libavcodec.
    *)
    AV_FRAME_DATA_PANSCAN
  );

  PAVFrameSideData = ^TAVFrameSideData;
  TAVFrameSideData = record
    type_: TAVFrameSideDataType;
    data:  PByte;
    size: cint;
    metadata: TAVDictionary;
  end; {TAVFrameSideData}

  (**
   * This structure describes decoded (raw) audio or video data.
   *
   * AVFrame must be allocated using av_frame_alloc(). Note that this only
   * allocates the AVFrame itself, the buffers for the data must be managed
   * through other means (see below).
   * AVFrame must be freed with av_frame_free().
   *
   * AVFrame is typically allocated once and then reused multiple times to hold
   * different data (e.g. a single AVFrame to hold frames received from a
   * decoder). In such a case, av_frame_unref() will free any references held by
   * the frame and reset it to its original clean state before it
   * is reused again.
   *
   * The data described by an AVFrame is usually reference counted through the
   * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
   * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
   * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
   * every single data plane must be contained in one of the buffers in
   * AVFrame.buf or AVFrame.extended_buf.
   * There may be a single buffer for all the data, or one separate buffer for
   * each plane, or anything in between.
   *
   * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
   * to the end with a minor bump.
   * Similarly fields that are marked as to be only accessed by
   * av_opt_ptr() can be reordered. This allows 2 forks to add fields
   * without breaking compatibility with each other.
  *)
  PPAVFrame = ^PAVFrame;
  PAVFrame = ^TAVFrame;
  TAVFrame = record
    (**
     * pointer to the picture/channel planes.
     * This might be different from the first allocated byte
     *
     * Some decoders access areas outside 0,0 - width,height, please
     * see avcodec_align_dimensions2(). Some filters and swscale can read
     * up to 16 bytes beyond the planes, if these filters are to be used,
     * then 16 extra bytes must be allocated.
    *)
    data: array [0..AV_NUM_DATA_POINTERS - 1] of pbyte;

    (**
     * For video, size in bytes of each picture line.
     * For audio, size in bytes of each plane.
     *
     * For audio, only linesize[0] may be set. For planar audio, each channel
     * plane must be the same size.
     *
     * For video the linesizes should be multiplies of the CPUs alignment
     * preference, this is 16 or 32 for modern desktop CPUs.
     * Some code requires such alignment other code can be slower without
     * correct alignment, for yet other it makes no difference.
     *
     * @note The linesize may be larger than the size of usable data -- there
     * may be extra padding present for performance reasons.
    *)
    linesize: array [0..AV_NUM_DATA_POINTERS - 1] of cint;

    (**
     * pointers to the data planes/channels.
     *
     * For video, this should simply point to data[].
     *
     * For planar audio, each channel has a separate data pointer, and
     * linesize[0] contains the size of each channel buffer.
     * For packed audio, there is just one data pointer, and linesize[0]
     * contains the total size of the buffer for all channels.
     *
     * Note: Both data and extended_data will always be set by get_buffer(),
     * but for planar audio with more channels that can fit in data,
     * extended_data must be used by the decoder in order to access all
     * channels.
     *
     * encoding: set by user
     * decoding: set by AVCodecContext.get_buffer()
    *)
    extended_data: ^pbyte;

    (**
     * width and height of the video frame
     * - encoding: unused
     * - decoding: Read by user.
     *)
    width, height: cint;
    (**
      * number of audio samples (per channel) described by this frame
     * - encoding: Set by user
     * - decoding: Set by libavcodec
    *)
    nb_samples: cint;

    (**
     * format of the frame, -1 if unknown or unset
     * Values correspond to enum AVPixelFormat for video frames,
     * enum AVSampleFormat for audio)
     * - encoding: unused
     * - decoding: Read by user.
    *)
    format: cint;

    (**
     * 1 -> keyframe, 0-> not
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
    *)
    key_frame: cint;

    (**
     * Picture type of the frame
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
     * - decoding: Set by libavcodec.
    *)
    pict_type: TAVPictureType;

{$IFDEF FF_API_AVFRAME_LAVC}
    (**
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
     * This isn't used by libavcodec unless the default get/release_buffer() is used.
     * - encoding:
     * - decoding:
    *)
    base: array [0..AV_NUM_DATA_POINTERS - 1] of pbyte; {deprecated}
{$ENDIF}

    (**
     * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
     * - encoding: unused
     * - decoding: Read by user.
    *)
    sample_aspect_ratio: TAVRational;

    (**
     * presentation timestamp in time_base units (time when frame should be shown to user)
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
    *)
    pts: cint64;

    (**
     * pts copied from the AVPacket that was decoded to produce this frame
     * - encoding: unused
     * - decoding: Read by user.
    *)
    pkt_pts: cint64;

    (**
     * dts copied from the AVPacket that triggered returning this frame
     * - encoding: unused
     * - decoding: Read by user.
    *)
    pkt_dts: cint64;

    (**
     * picture number in bitstream order
     * - encoding: set by
     * - decoding: Set by libavcodec.
    *)
    coded_picture_number: cint;

    (**
     * picture number in display order
     * - encoding: set by
     * - decoding: Set by libavcodec.
    *)
    display_picture_number: cint;

    (**
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
     * - decoding: Set by libavcodec.
    *)
    quality: cint;

{$IFDEF FF_API_AVFRAME_LAVC}
    reference: cint; {deprecated}

    (**
     * QP table
    *)
    qscale_table: pbyte; {deprecated}

    (**
     * QP store stride
    *)
    qstride: cint; {deprecated}
    qscale_type: cint; {deprecated}

    (**
     * mbskip_table[mb]>=1 if MB didn't change
     * stride= mb_width = (width+15)>>4
    *)
    mbskip_table: pbyte; {deprecated}

    (**
     * motion vector table
     * @code
     * example:
     * int mv_sample_log2= 4 - motion_subsample_log2;
     * int mb_width= (width+15)>>4;
     * int mv_stride= (mb_width << mv_sample_log2) + 1;
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
     * @endcode
    *)
    motion_val: array [0..1] of pointer; {deprecated}

    (**
     * macroblock type table
     * mb_type_base + mb_width + 2
    *)
    mb_type: PCuint; {deprecated}

    (**
     * DCT coefficients
    *)
    dct_coeff: PsmallInt; {deprecated}

    (**
     * motion reference frame index
     * the order in which these are stored can depend on the codec.
    *)
    ref_index: array [0..1] of pbyte; {deprecated}
{$ENDIF}

    (**
     * for some private data of the user
     * - encoding: unused
     * - decoding: Set by user.
    *)
    opaque: pointer;

    (**
     * error
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
     * - decoding: unused
    *)
    error: array [0..AV_NUM_DATA_POINTERS - 1] of cuint64;

{$IFDEF FF_API_AVFRAME_LAVC}
    type_: cint; {deprecated}
{$ENDIF}

    (**
     * When decoding, this signals how much the picture must be delayed.
     * extra_delay = repeat_pict / (2*fps)
     * - encoding: unused
     * - decoding: Set by libavcodec.
    *)
    repeat_pict: cint;

    (**
     * The content of the picture is interlaced.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec. (default 0)
    *)
    interlaced_frame: cint;

    (**
     * If the content is interlaced, is top field displayed first.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
    *)
    top_field_first: cint;

    (**
     * Tell user application that palette has changed from previous frame.
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: Set by libavcodec. (default 0).
    *)
    palette_has_changed: cint;

{$IFDEF FF_API_AVFRAME_LAVC}
    buffer_hints: cint; {deprecated}
    (**
     * Pan scan.
    *)
    pan_scan: PAVPanScan; {deprecated}
{$ENDIF}

    (**
     * reordered opaque 64bit (generally an integer or a double precision float
     * PTS but can be anything).
     * The user sets AVCodecContext.reordered_opaque to represent the input at
     * that time,
     * the decoder reorders values as needed and sets AVFrame.reordered_opaque
     * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
     * @deprecated in favor of pkt_pts
     * - encoding: unused
     * - decoding: Read by user.
    *)
    reordered_opaque: cint64;

{$IFDEF FF_API_AVFRAME_LAVC}
    (**
     * @deprecated this field is unused
    *)
    hwaccel_picture_private: pointer; {deprecated}
    owner: PAVCodecContext; {deprecated}
    thread_opaque: pointer; {deprecated}

    (**
     * log2 of the size of the block which a single vector in motion_val represents:
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
    *)
    motion_subsample_log2: cuint8; {deprecated}
{$ENDIF}

    (**
     * Sample rate of the audio data.
     *
     * - encoding: unused
     * - decoding: read by user
     *)
    sample_rate: cint;

    (**
     * Channel layout of the audio data.
     *
     * - encoding: unused
     * - decoding: read by user.
     *)
    channel_layout: cuint64;

    (**
     * AVBuffer references backing the data for this frame. If all elements of
     * this array are NULL, then this frame is not reference counted.
     *
     * There may be at most one AVBuffer per data plane, so for video this array
     * always contains all the references. For planar audio with more than
     * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
     * this array. Then the extra AVBufferRef pointers are stored in the
     * extended_buf array.
    *)
    buf: array [0..AV_NUM_DATA_POINTERS - 1] of PAVBufferRef;

    (**
     * For planar audio which requires more than AV_NUM_DATA_POINTERS
     * AVBufferRef pointers, this array will hold all the references which
     * cannot fit into AVFrame.buf.
     *
     * Note that this is different from AVFrame.extended_data, which always
     * contains all the pointers. This array only contains the extra pointers,
     * which cannot fit into AVFrame.buf.
     *
     * This array is always allocated using av_malloc() by whoever constructs
     * the frame. It is freed in av_frame_unref().
    *)
    extended_buf: PPAVBufferRef;

    (**
     * Number of elements in extended_buf.
     *)
    nb_extended_buf: cint;

    side_data: ^PAVFrameSideData;
    nb_side_data: cint;

    (**
     * frame timestamp estimated using various heuristics, in stream time base
     * Code outside libavcodec should access this field using:
     * av_frame_get_best_effort_timestamp(frame)
     * - encoding: unused
     * - decoding: set by libavcodec, read by user.
    *)
    best_effort_timestamp: cint64;

    (**
     * reordered pos from the last AVPacket that has been input into the decoder
     * Code outside libavcodec should access this field using:
     * av_frame_get_pkt_pos(frame)
     * - encoding: unused
     * - decoding: Read by user.
    *)
    pkt_pos: cint64;

    (**
     * duration of the corresponding packet, expressed in
     * AVStream->time_base units, 0 if unknown.
     * Code outside libavcodec should access this field using:
     * av_frame_get_pkt_duration(frame)
     * - encoding: unused
     * - decoding: Read by user.
    *)
    pkt_duration: cint64;

    (**
     * metadata.
     * Code outside libavcodec should access this field using:
     * av_frame_get_metadata(frame)
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
    *)
    metadata: PAVDictionary;

    (**
     * decode error flags of the frame, set to a combination of
     * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
     * were errors during the decoding.
     * Code outside libavcodec should access this field using:
     * av_frame_get_decode_error_flags(frame)
     * - encoding: unused
     * - decoding: set by libavcodec, read by user.
    *)
    decode_error_flags: cint;

    (**
     * number of audio channels, only used for audio.
     * Code outside libavcodec should access this field using:
     * av_frame_get_channels(frame)
     * - encoding: unused
     * - decoding: Read by user.
    *)
    channels: cint;

    (**
     * size of the corresponding packet containing the compressed
     * frame. It must be accessed using av_frame_get_pkt_size() and
     * av_frame_set_pkt_size().
     * It is set to a negative value if unknown.
     * - encoding: unused
     * - decoding: set by libavcodec, read by user.
    *)
    pkt_size: cint;

    (**
     * YUV colorspace type.
     * It must be accessed using av_frame_get_colorspace() and
     * av_frame_set_colorspace().
     * - encoding: Set by user
     * - decoding: Set by libavcodec
    *)
    colorspace: TAVColorSpace;

    (**
     * MPEG vs JPEG YUV range.
     * It must be accessed using av_frame_get_color_range() and
     * av_frame_set_color_range().
     * - encoding: Set by user
     * - decoding: Set by libavcodec
    *)
    color_range: TAVColorRange;

    (**
     * Not to be accessed directly from outside libavutil
    *)
    qp_table_buf: PAVBufferRef;
  end; {TAVFrame}

  (**
   * Accessors for some AVFrame fields.
   * The position of these field in the structure is not part of the ABI,
   * they should not be accessed directly outside libavcodec.
   *)
  function  av_frame_get_best_effort_timestamp(frame: {const} PAVFrame): cint64;
    cdecl; external av__codec; overload;
  procedure av_frame_set_best_effort_timestamp(frame: PAVFrame; val: cint64);
    cdecl; external av__codec; overload;
  function  av_frame_get_pkt_duration         (frame: {const} PAVFrame): cint64;
    cdecl; external av__codec; overload;
  procedure av_frame_get_pkt_duration         (frame: PAVFrame; val: cint64);
    cdecl; external av__codec; overload;
  function  av_frame_get_pkt_pos              (frame: {const} PAVFrame): cint64;
    cdecl; external av__codec; overload;
  procedure av_frame_get_pkt_pos              (frame: PAVFrame; val: cint64);
    cdecl; external av__codec; overload;
  function  av_frame_get_channel_layout       (frame: {const} PAVFrame): cint64;
    cdecl; external av__codec; overload;
  procedure av_frame_get_channel_layout       (frame: PAVFrame; val: cint64);
    cdecl; external av__codec; overload;
  function  av_frame_get_channels             (frame: {const} PAVFrame): cint;
    cdecl; external av__codec;
  procedure av_frame_set_channels             (frame: PAVFrame; val: cint);
    cdecl; external av__codec;
  function  av_frame_get_sample_rate          (frame: {const} PAVFrame): cint;
    cdecl; external av__codec;
  procedure av_frame_set_sample_rate          (frame: PAVFrame; val: cint);
    cdecl; external av__codec;
  function  av_frame_get_metadata             (frame: {const} PAVFrame): PAVDictionary;
    cdecl; external av__codec;
  procedure av_frame_set_metadata             (frame: PAVFrame; val: PAVDictionary);
    cdecl; external av__codec;
  function  av_frame_get_decode_error_flags   (frame: {const} PAVFrame): cint;
    cdecl; external av__codec;
  procedure av_frame_set_decode_error_flags   (frame: PAVFrame; val: cint);
    cdecl; external av__codec;
  function  av_frame_get_pkt_size             (frame: {const} PAVFrame): cint;
    cdecl; external av__codec;
  procedure av_frame_set_pkt_size             (frame: PAVFrame; val: cint);
    cdecl; external av__codec;
  function avpriv_frame_get_metadatap(frame: PAVFrame): PPAVDictionary;
    cdecl; external av__codec;
  function av_frame_get_qp_table(f: PAVFrame; stride: pcint; type_: pcint): PByte;
    cdecl; external av__codec;
  function av_frame_set_qp_table(f: PAVFrame; buf: PAVBufferRef; stride: cint; type_: cint): cint;
    cdecl; external av__codec;
  function av_frame_get_colorspace(frame: {const} PAVFrame): TAVColorSpace;
    cdecl; external av__codec;
  procedure av_frame_set_colorspace(frame: PAVFrame; val: TAVColorSpace);
    cdecl; external av__codec;
  procedure av_frame_set_color_range(frame: PAVFrame; val: TAVColorSpace);
    cdecl; external av__codec;

  (**
   * Get the name of a colorspace.
   * @return a static string identifying the colorspace; can be NULL.
   *)
  function av_get_colorspace_name(val: TAVColorSpace): PAnsiChar;
    cdecl; external av__codec;

  (**
   * Allocate an AVFrame and set its fields to default values.  The resulting
   * struct must be freed using av_frame_free().
   *
   * @return An AVFrame filled with default values or NULL on failure.
   *
   * @note this only allocates the AVFrame itself, not the data buffers. Those
   * must be allocated through other means, e.g. with av_frame_get_buffer() or
   * manually.
   *)
  function av_frame_alloc(): PAVFrame;
    cdecl; external av__codec;

  (**
   * Free the frame and any dynamically allocated objects in it,
   * e.g. extended_data. If the frame is reference counted, it will be
   * unreferenced first.
   *
   * @param frame frame to be freed. The pointer will be set to NULL.
   *)
  procedure av_frame_free(frame: PPAVFrame);
    cdecl; external av__codec;

  (**
   * Setup a new reference to the data described by a given frame.
   *
   * Copy frame properties from src to dst and create a new reference for each
   * AVBufferRef from src.
   *
   * If src is not reference counted, new buffers are allocated and the data is
   * copied.
   *
   * @return 0 on success, a negative AVERROR on error
   *)
  function av_frame_ref(dst: PAVFrame; src: PAVFrame): cint;
    cdecl; external av__codec;

  (**
   * Create a new frame that references the same data as src.
   *
   * This is a shortcut for av_frame_alloc()+av_frame_ref().
   *
   * @return newly created AVFrame on success, NULL on error.
   *)
  function av_frame_clone(src: PAVFrame): PAVFrame;
    cdecl; external av__codec;

  (**
   * Unreference all the buffers referenced by frame and reset the frame fields.
   *)
  procedure av_frame_unref(frame: PAVFrame);
    cdecl; external av__codec;

  (**
   * Move everythnig contained in src to dst and reset src.
   *)
  procedure av_frame_move_ref(dst, src: PAVFrame);
    cdecl; external av__codec;

  (**
   * Allocate new buffer(s) for audio or video data.
   *
   * The following fields must be set on frame before calling this function:
   * - format (pixel format for video, sample format for audio)
   * - width and height for video
   * - nb_samples and channel_layout for audio
   *
   * This function will fill AVFrame.data and AVFrame.buf arrays and, if
   * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
   * For planar formats, one buffer will be allocated for each plane.
   *
   * @param frame frame in which to store the new buffers.
   * @param align required buffer size alignment
   *
   * @return 0 on success, a negative AVERROR on error.
   *)
  function av_frame_get_buffer(frame: PAVFrame; align: cint): cint;
    cdecl; external av__codec;

  (**
   * Check if the frame data is writable.
   *
   * @return A positive value if the frame data is writable (which is true if and
   * only if each of the underlying buffers has only one reference, namely the one
   * stored in this frame). Return 0 otherwise.
   *
   * If 1 is returned the answer is valid until av_buffer_ref() is called on any
   * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
   *
   * @see av_frame_make_writable(), av_buffer_is_writable()
   *)
  function av_frame_is_writable(frame: PAVFrame): cint;
    cdecl; external av__codec;

  (**
   * Ensure that the frame data is writable, avoiding data copy if possible.
   *
   * Do nothing if the frame is writable, allocate new buffers and copy the data
   * if it is not.
   *
   * @return 0 on success, a negative AVERROR on error.
   *
   * @see av_frame_is_writable(), av_buffer_is_writable(),
   * av_buffer_make_writable()
   *)
  function av_frame_make_writable(frame: PAVFrame): cint;
    cdecl; external av__codec;

  (**
   * Copy only "metadata" fields from src to dst.
   *
   * Metadata for the purpose of this function are those fields that do not affect
   * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
   * aspect ratio (for video), but not width/height or channel layout.
   * Side data is also copied.
   *)
  function av_frame_copy_props(dst: PAVFrame; src: {const} PAVFrame): cint;
    cdecl; external av__codec;

  (**
   * Get the buffer reference a given data plane is stored in.
   *
   * @param plane index of the data plane of interest in frame->extended_data.
   *
   * @return the buffer reference that contains the plane or NULL if the input
   * frame is not valid.
   *)
  function av_frame_get_plane_buffer(frame: PAVFrame; plane: cint): PAVBufferRef;
    cdecl; external av__codec;

  (**
   * Add a new side data to a frame.
   *
   * @param frame a frame to which the side data should be added
   * @param type type of the added side data
   * @param size size of the side data
   *
   * @return newly added side data on success, NULL on error
   *)
  function av_frame_new_side_data(frame: PAVFrame;
                                            type_: TAVFrameSideDataType;
                                            size: cint): PAVFrameSideData;
    cdecl; external av__codec;

  (**
   * @return a pointer to the side data of a given type on success, NULL if there
   * is no side data with such type in this frame.
   *)
  function av_frame_get_side_data(frame: {const} PAVFrame; type_: TAVFrameSideDataType): PAVFrameSideData;
    cdecl; external av__codec;