path: root/src/lib/ffmpeg-2.2/avutil.pas

(*
 * copyright (c) 2006 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
 *
 * Conversions of
 *
 * libavutil/avutil.h:
 * version: 52.66.100
 *
 *)

unit avutil;

{$IFDEF FPC}
  {$MODE DELPHI}
  {$PACKENUM 4}    (* use 4-byte enums *)
  {$PACKRECORDS C} (* C/C++-compatible record packing *)
  {$MACRO ON}      (* Turn macro support on *)
{$ELSE}
  {$MINENUMSIZE 4} (* use 4-byte enums *)
{$ENDIF}

{$I ff_api-defines.inc}  (* FF_API_* defines *)

{$IFDEF DARWIN}
  {$linklib libavutil}
{$ENDIF}

interface

uses
  ctypes,
  rational,
  {$IFDEF UNIX}
  BaseUnix,
  {$ENDIF}
  UConfig;

const
  (* Max. supported version by this header *)
  LIBAVUTIL_MAX_VERSION_MAJOR   = 52;
  LIBAVUTIL_MAX_VERSION_MINOR   = 66;
  LIBAVUTIL_MAX_VERSION_RELEASE = 100;
  LIBAVUTIL_MAX_VERSION = (LIBAVUTIL_MAX_VERSION_MAJOR * VERSION_MAJOR) +
                          (LIBAVUTIL_MAX_VERSION_MINOR * VERSION_MINOR) +
                          (LIBAVUTIL_MAX_VERSION_RELEASE * VERSION_RELEASE);

  (* Min. supported version by this header *)
  LIBAVUTIL_MIN_VERSION_MAJOR   = 52;
  LIBAVUTIL_MIN_VERSION_MINOR   = 66;
  LIBAVUTIL_MIN_VERSION_RELEASE = 100;
  LIBAVUTIL_MIN_VERSION = (LIBAVUTIL_MIN_VERSION_MAJOR * VERSION_MAJOR) +
                          (LIBAVUTIL_MIN_VERSION_MINOR * VERSION_MINOR) +
                          (LIBAVUTIL_MIN_VERSION_RELEASE * VERSION_RELEASE);

(* Check if linked versions are supported *)
{$IF (LIBAVUTIL_VERSION < LIBAVUTIL_MIN_VERSION)}
  {$MESSAGE Error 'Linked version of libavutil is too old!'}
{$IFEND}

{$IF (LIBAVUTIL_VERSION > LIBAVUTIL_MAX_VERSION)}
  {$MESSAGE Error 'Linked version of libavutil is not yet supported!'}
{$IFEND}


(**
 * @}
 *
 * @defgroup depr_guards Deprecation guards
 * FF_API_* defines may be placed below to indicate public API that will be
 * dropped at a future version bump. The defines themselves are not part of
 * the public API and may change, break or disappear at any time.
 *
 * @{
 *)

{$ifndef FF_API_GET_BITS_PER_SAMPLE_FMT}
{$define FF_API_GET_BITS_PER_SAMPLE_FMT := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_FIND_OPT}
{$define FF_API_FIND_OPT                := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_OLD_AVOPTIONS}
{$define FF_API_OLD_AVOPTIONS           := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_PIX_FMT}
{$define FF_API_PIX_FMT                 := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_CONTEXT_SIZE}
{$define FF_API_CONTEXT_SIZE            := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_PIX_FMT_DESC}
{$define FF_API_PIX_FMT_DESC            := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_AV_REVERSE}
{$define FF_API_AV_REVERSE              := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_AUDIOCONVERT}
{$define FF_API_AUDIOCONVERT            := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_CPU_FLAG_MMX2}
{$define FF_API_CPU_FLAG_MMX2           := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_SAMPLES_UTILS_RETURN_ZERO}
{$define FF_API_SAMPLES_UTILS_RETURN_ZERO := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_LLS_PRIVATE}
{$define FF_API_LLS_PRIVATE              := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_LLS1}
{$define FF_API_LLS1                     :=(LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_AVFRAME_LAVC}
{$define FF_API_AVFRAME_LAVC             := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_VDPAU}
{$define FF_API_VDPAU                    := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_GET_CHANNEL_LAYOUT_COMPAT}
{$define FF_API_GET_CHANNEL_LAYOUT_COMPAT := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_OLD_OPENCL}
{$define FF_API_OLD_OPENCL               := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_XVMC}
{$define FF_API_XVMC                     := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_INTFLOAT
{$define FF_API_INTFLOAT                 := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
{$ifndef FF_API_OPT_TYPE_METADATA}
{$define FF_API_OPT_TYPE_METADATA        := (LIBAVUTIL_VERSION_MAJOR < 54)}
{$endif}
  
type
{$IFNDEF FPC}
  // defines for Delphi
  size_t = cardinal;
{$ENDIF}
  Psize_t = ^size_t;

(**
 * Return the LIBAVUTIL_VERSION_INT constant.
 *)
function avutil_version(): cuint;
  cdecl; external av__util;

(**
 * Return the libavutil build-time configuration.
 *)
function avutil_configuration(): PAnsiChar;
  cdecl; external av__util;

(**
 * Return the libavutil license.
 *)
function avutil_license(): PAnsiChar;
  cdecl; external av__util;

(**
 * @addtogroup lavu_media Media Type
 * @brief Media Type
 *)

type

  PAVFile = pointer;

  TAVMediaType = (
    AVMEDIA_TYPE_UNKNOWN = -1,  ///< Usually treated as AVMEDIA_TYPE_DATA
    AVMEDIA_TYPE_VIDEO,
    AVMEDIA_TYPE_AUDIO,
    AVMEDIA_TYPE_DATA,          ///< Opaque data information usually continuous
    AVMEDIA_TYPE_SUBTITLE,
    AVMEDIA_TYPE_ATTACHMENT,    ///< Opaque data information usually sparse
    AVMEDIA_TYPE_NB
  );

(**
 * Return a string describing the media_type enum, NULL if media_type
 * is unknown.
 *)
function av_get_media_type_string(media_type: TAVMediaType): PAnsiChar;
  cdecl; external av__util;

const
  FF_LAMBDA_SHIFT = 7;
  FF_LAMBDA_SCALE = (1 shl FF_LAMBDA_SHIFT);
  FF_QP2LAMBDA    = 118; ///< factor to convert from H.263 QP to lambda
  FF_LAMBDA_MAX   = (256*128-1);
 
  FF_QUALITY_SCALE = FF_LAMBDA_SCALE; //FIXME maybe remove
 
(**
 * @brief Undefined timestamp value
 *
 * Usually reported by demuxer that work on containers that do not provide
 * either pts or dts.
 *)

  AV_NOPTS_VALUE   = $8000000000000000;

(**
 * Internal time base represented as integer
 *)

  AV_TIME_BASE     = 1000000;
  
(**
 * Internal time base represented as fractional value
 *)

  AV_TIME_BASE_Q   : TAVRational = (num: 1; den: AV_TIME_BASE);

(**
 * @}
 * @}
 * @defgroup lavu_picture Image related
 *
 * AVPicture types, pixel formats and basic image planes manipulation.
 *
 * @
 *)

type
  TAVPictureType = (
    AV_PICTURE_TYPE_NONE = 0, ///< Undefined
    AV_PICTURE_TYPE_I,     ///< Intra
    AV_PICTURE_TYPE_P,     ///< Predicted
    AV_PICTURE_TYPE_B,     ///< Bi-dir predicted
    AV_PICTURE_TYPE_S,     ///< S(GMC)-VOP MPEG4
    AV_PICTURE_TYPE_SI,    ///< Switching Intra
    AV_PICTURE_TYPE_SP,    ///< Switching Predicted
    AV_PICTURE_TYPE_BI     ///< BI type
  );

(**
 * Return a single letter to describe the given picture type
 * pict_type.
 *
 * @param[in] pict_type the picture type @return a single character
 * representing the picture type, '?' if pict_type is unknown
 *)
function av_get_picture_type_char(pict_type: TAVPictureType): PAnsiChar;
  cdecl; external av__util;

(**
 * Return x default pointer in case p is NULL.
 *)
function av_x_if_null(p: {const} pointer; x: {const} pointer): pointer; {$IFDEF HasInline}inline;{$ENDIF}

(**
 * Compute the length of an integer list.
 *
 * @param elsize  size in bytes of each list element (only 1, 2, 4 or 8)
 * @param term    list terminator (usually 0 or -1)
 * @param list    pointer to the list
 * @return  length of the list, in elements, not counting the terminator
 *)
function av_int_list_length_for_size(elsize: cuint;
                                     {const} list: pointer; term: cuint64): cuint; {av_pure}
  cdecl; external av__util;

(**
 * Compute the length of an integer list.
 *
 * @param term  list terminator (usually 0 or -1)
 * @param list  pointer to the list
 * @return  length of the list, in elements, not counting the terminator
 *)
function av_int_list_length({const} list: pointer; term: cuint64): cuint;

(**
 * Open a file using a UTF-8 filename.
 * The API of this function matches POSIX fopen(), errors are returned through
 * errno.
 *)
function av_fopen_utf8(path: {const} Pchar; mode: {const} Pchar): PAVFile;
  cdecl; external av__util;

{$INCLUDE libavutil/cpu.pas}

{$INCLUDE libavutil/dict.pas}

{$INCLUDE libavutil/error.pas}

{$INCLUDE libavutil/mathematics.pas}

{$INCLUDE libavutil/mem.pas}

{$INCLUDE libavutil/log.pas}

{$INCLUDE libavutil/pixfmt.pas}

{$INCLUDE libavutil/samplefmt.pas}

{$INCLUDE libavutil/opt.pas}

{$INCLUDE libavutil/buffer.pas}

{$INCLUDE libavutil/frame.pas}


(* libavutil/common.h *) // until now MKTAG and MKBETAG is all from common.h KMS 19/5/2010

(**
 * MKTAG and MKBETAG are usually used to convert a magic string to an enumeration index.
 * In Pascal this can probably not be used and the functions could be removed.
 * KMS 8/6/2012
 *)
function MKTAG  (a, b, c, d: AnsiChar): integer; {$IFDEF HasInline}inline;{$ENDIF}
function MKBETAG(a, b, c, d: AnsiChar): integer; {$IFDEF HasInline}inline;{$ENDIF}

implementation

uses
  SysUtils;

function av_x_if_null(p: {const} pointer; x: {const} pointer): pointer; {$IFDEF HasInline}inline;{$ENDIF}
begin
  if p = nil then
    Result := x
  else
    Result := p;
end;

function av_int_list_length({const} list: pointer; term: cuint64): cuint;
begin
  // KMS 2013: It is not really clear whether it should be sizeof(pointer) or sizeof(cint).
  // Going for the larger one (pointer) should at least prevent buffer overflows.
  // So, the result is either 4 byte or 8 byte.
  Result := av_int_list_length_for_size(sizeof(pointer), list, term);
end;

(* libavutil/common.h *)

function MKTAG(a, b, c, d: AnsiChar): integer; {$IFDEF HasInline}inline;{$ENDIF}
begin
  Result := (ord(a) or (ord(b) shl 8) or (ord(c) shl 16) or (ord(d) shl 24));
end;

function MKBETAG(a, b, c, d: AnsiChar): integer; {$IFDEF HasInline}inline;{$ENDIF}
begin
  Result := (ord(d) or (ord(c) shl 8) or (ord(b) shl 16) or (ord(a) shl 24));
end;

(* libavutil/error.h *)

function av_make_error_string(errbuf: Pchar; errbuf_size: size_t; errnum: cint): Pchar; {$IFDEF HasInline}inline;{$ENDIF}
begin
  av_strerror(errnum, errbuf, errbuf_size);
  av_make_error_string := errbuf;
end;

function av_err2str(errnum: cint): pchar; {$IFDEF HasInline}inline;{$ENDIF}
var
  errbuf: Pchar;
begin
  errbuf := stralloc(AV_ERROR_MAX_STRING_SIZE);
  av_make_error_string(errbuf, AV_ERROR_MAX_STRING_SIZE, errnum);
  av_err2str := errbuf;
end;

(* libavutil/mem.h *)

function av_size_mult(a: size_t; b: size_t; r: Psize_t): size_t;
  cdecl; external av__util;
(* To Be Implemented, March 2012 KMS *)
//function av_size_mult(a: size_t; b: size_t; r: pointer): size_t;
//begin
//    {
//    size_t t = a * b;
//    /* Hack inspired from glibc: only try the division if nelem and elsize
//     * are both greater than sqrt(SIZE_MAX). */
//    if ((a | b) >= ((size_t)1 << (sizeof(size_t) * 4)) && a && t / a != b)
//        return AVERROR(EINVAL);
//    *r = t;
//    return 0;
//}
//end;

function av_malloc_array(nmemb: size_t; size: size_t): pointer; {$IFDEF HasInline}inline;{$ENDIF} {av_alloc_size(1,2)}
begin
  if (size <= 0 ) or (nmemb >= maxint / size) then
    av_malloc_array := NIL
  else
    av_malloc_array := av_malloc(nmemb * size);
end;

function av_mallocz_array(nmemb: size_t; size: size_t): pointer; {$IFDEF HasInline}inline;{$ENDIF} {av_alloc_size(1,2)}
begin
  if (size <= 0 ) or (nmemb >= maxint / size) then
    av_mallocz_array := NIL
  else
    av_mallocz_array := av_mallocz(nmemb * size);
end;

end.