Aasimon.org Wiki - ffmpeg

avcodec

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T09:42:41+00:00

AVCodec Defined in avcodec.h /** * AVCodec. */ typedef struct AVCodec { /** * Name of the codec implementation. * The name is globally unique among encoders and among decoders (but an * encoder and a decoder can share the same name). * This is the primary way to find a codec from the user perspective. */ const char *name; enum CodecType type; enum CodecID id; int priv_data_size; int (*init)(AVCodecContext *); int (*encode)(AVCodecContext …

avcodeccontext

Anonymous (anonymous@undisclosed.example.com) — 2008-01-02T12:57:39+00:00

AVCodecContext Defined in avcodec.h /** * main external API structure */ typedef struct AVCodecContext { /** * information on struct for av_log * - set by avcodec_alloc_context */ AVClass *av_class; /** * the average bitrate * - encoding: Set by user; unused for constant quantizer encoding. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream. */ int bit_rate; /** * number of bits the bitstrea…

avcodec_alloc_context

Anonymous (anonymous@undisclosed.example.com) — 2008-01-22T08:19:20+00:00

avcodec_alloc_context Overview Defined in avcodec.h Allocates an AVCodecContext and sets its fields to default values. The resulting struct can be deallocated by simply calling av_free(). AVCodecContext *avcodec_alloc_context(void); Parameters Return value

avcodec_alloc_frame

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T09:58:59+00:00

avcodec_alloc_frame Overview Defined in avcodec.h Allocates an AVFrame and sets its fields to default values. The resulting struct can be deallocated by simply calling av_free(). AVFrame *avcodec_alloc_frame(void); Parameters NONE Return value An

avcodec_decode_audio

Anonymous (anonymous@undisclosed.example.com) — 2007-12-30T13:51:43+00:00

/** * @deprecated Use avcodec_decode_audio2() instead. */ attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, int *frame_size_ptr, uint8_t *buf, int buf_size);

avcodec_decode_audio2

Anonymous (anonymous@undisclosed.example.com) — 2007-12-30T13:52:01+00:00

/** * Decodes an audio frame from \p buf into \p samples. * The avcodec_decode_audio2() function decodes an audio frame from the input * buffer \p buf of size \p buf_size. To decode it, it makes use of the * audio codec which was coupled with \p avctx using avcodec_open(). The * resulting decoded frame is stored in output buffer \p samples. If no frame * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the * decompressed frame size in \e bytes. * * @warning You \e mus…

avcodec_decode_video

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T15:49:39+00:00

avcodec_decode_video Overview Defined in avcodec.h Decodes a video frame from buf into picture. The avcodec_decode_video() function decodes a video frame from the input buffer buf of size buf_size. To decode it, it makes use of the video codec which was coupled with

avcodec_encode_audio

Anonymous (anonymous@undisclosed.example.com) — 2007-12-14T13:33:25+00:00

avcodec_encode_audio Overview Defined in avcodec.h Encodes an audio frame from samples into buf. The avcodec_encode_audio() function encodes an audio frame from the input buffer samples. To encode it, it makes use of the audio codec which was coupled with avctx using

avcodec_encode_subtitle

Anonymous (anonymous@undisclosed.example.com) — 2007-12-14T13:46:47+00:00

avcodec_encode_subtitle Overview Defined in avcodec.h Encodes a subtitle frame from sub into buf. The avcodec_encode_subtitle() function encodes a video frame from the input sub. To encode it, it makes use of the video codec which was coupled with avctx using avcodec_open(). The resulting encoded bytes representing the frame are stored in the output buffer

avcodec_encode_video

Anonymous (anonymous@undisclosed.example.com) — 2007-12-14T13:38:34+00:00

avcodec_encode_video Overview Defined in avcodec.h Encodes a video frame from pict into buf. The avcodec_encode_video() function encodes a video frame from the input pict. To encode it, it makes use of the video codec which was coupled with avctx using avcodec_open(). The resulting encoded bytes representing the frame are stored in the output buffer

avcodec_find_decoder

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T11:07:41+00:00

avcodec_find_decoder Overview Defined in avcodec.h Finds a decoder with a matching codec ID. AVCodec *avcodec_find_decoder(enum CodecID id); Parameters id enum CodecID id CodecID of the requested decoder. Return value A pointer to an AVCodec, containing a decoder if one was found, NULL otherwise.

avcodec_find_encoder

Anonymous (anonymous@undisclosed.example.com) — 2007-12-14T13:22:43+00:00

avcodec_find_encoder Overview Defined in avcodec.h Finds an encoder with a matching codec ID. AVCodec *avcodec_find_encoder(enum CodecID id); Parameters id enum CodecID id CodecID of the requested encoder. Return value Returns an encoder AVCodec pointer if one was found, NULL otherwise.

avcodec_find_encoder_by_name

Anonymous (anonymous@undisclosed.example.com) — 2007-12-14T13:24:26+00:00

avcodec_find_encoder_by_name Overview Defined in avcodec.h Finds an encoder with the specified name. AVCodec *avcodec_find_encoder_by_name(const char *name); Parameters name const char *name The name of the requested encoder. Return value

avcodec_open

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T11:08:17+00:00

avcodec_open Overview Defined in avcodec.h Initializes the AVCodecContext to use the given AVCodec. Prior to using this function the context has to be allocated. The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for retrieving a codec. WARNING: This function is not thread safe!

averror

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:24:55+00:00

AVERROR Defined in avcodec.h /* error handling */ #if EINVAL > 0 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */ #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */ #else /* Some platforms have E* and errno already negated. */ #define AVERROR(e) (e) #define AVUNERROR(e) (e) #endif #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */ #define AVERROR_I…

avformatcontext

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T16:08:31+00:00

AVFormatContext Defined in avformat.h /* format I/O context */ typedef struct AVFormatContext { const AVClass *av_class; /**< set by av_alloc_format_context */ /* can only be iformat or oformat, not both at the same time */ struct AVInputFormat *iformat; struct AVOutputFormat *oformat; void *priv_data; ByteIOContext pb; unsigned int nb_streams; AVStream *streams[MAX_STREAMS]; char filename[1024]; /**< input or output filename */ /* stream info */ in…

avformatparameters

Anonymous (anonymous@undisclosed.example.com) — 2009-07-21T07:24:42+00:00

AVFormatParameters Defined in avformat.h typedef struct AVFormatParameters { AVRational time_base; int sample_rate; int channels; int width; int height; enum PixelFormat pix_fmt; int channel; /**< used to select dv channel */ #if LIBAVFORMAT_VERSION_INT < (52<<16) const char *device; /**< video, audio or DV device */ #endif const char *standard; /**< tv standard, NTSC, PAL, SECAM */ int mpeg2ts_raw:1; /**< force raw MPEG2 transport stream output, if po…

avframe

Anonymous (anonymous@undisclosed.example.com) — 2009-07-21T07:02:16+00:00

AVFrame Defined in avcodec.h Superset of AVPicture /** * Audio Video Frame. */ typedef struct AVFrame { /** * pointer to the picture planes. * This might be different from the first allocated byte * - encoding: * - decoding: */ uint8_t *data[4]; int linesize[4]; /** * 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…

avinputformat

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T09:01:33+00:00

AVInputFormat Defined in avformat.h typedef struct AVInputFormat { const char *name; const char *long_name; /** size of private data so that it can be allocated in the wrapper */ int priv_data_size; /** tell if a given file has a chance of being parsed by this format */ int (*read_probe)(AVProbeData *); /** read the format header and initialize the AVFormatContext structure. Return 0 if OK. 'ap' if non NULL contains additional paramters. Only used in …

avoutputformat

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T09:08:11+00:00

AVOuputFormat Defined in avformat.h typedef struct AVOutputFormat { const char *name; const char *long_name; const char *mime_type; const char *extensions; /**< comma separated filename extensions */ /** size of private data so that it can be allocated in the wrapper */ int priv_data_size; /* output support */ enum CodecID audio_codec; /**< default audio codec */ enum CodecID video_codec; /**< default video codec */ int (*write_header)(struct AVFormatCo…

avpacket

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T13:52:36+00:00

AVPacket Defined in avformat.h typedef struct AVPacket { int64_t pts; ///< presentation time stamp in time_base units int64_t dts; ///< decompression time stamp in time_base units uint8_t *data; int size; int stream_index; int flags; int duration; ///< presentation duration in time_base units (0 if not available) void (*destruct)(struct AVPacket *); void *priv; int64…

avpicture

Anonymous (anonymous@undisclosed.example.com) — 2009-07-20T12:39:12+00:00

AVPicture Defined in avcodec.h Subset of AVFrame /** * four components are given, that's all. * the last component is alpha */ typedef struct AVPicture { uint8_t *data[4]; int linesize[4]; ///< number of bytes per line } AVPicture;

avpicture_fill

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T10:47:31+00:00

avpicture_fill Overview Defined in avcodec.h Fill in the AVPicture fields. The fields of the given AVPicture are filled in by using the 'ptr' address which points to the image data buffer. Depending on the specified picture format, one or multiple image data pointers and line sizes will be set.

avpicture_get_size

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T10:39:12+00:00

avpicture_get_size Overview Defined in avcodec.h Calculate the size in bytes that a picture of the given width and height would occupy if stored in the given picture format. int avpicture_get_size(int pix_fmt, int width, int height); Parameters

avrational

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T13:24:28+00:00

AVRational Defined in rational.h /** * Rational number num/den. */ typedef struct AVRational{ int num; ///< numerator int den; ///< denominator } AVRational;

avstream

Anonymous (anonymous@undisclosed.example.com) — 2007-12-29T11:55:11+00:00

AVStream Defined in avformat.h typedef struct AVStream { int index; /**< stream index in AVFormatContext */ int id; /**< format specific stream id */ AVCodecContext *codec; /**< codec context */ /** * real base frame rate of the stream. * this is the lowest framerate with which all timestamps can be * represented accurately (it is the least common multiple of all * framerates in the stream), Note, this value is just a guess! * for example if t…

av_alloc_format_context

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T10:21:10+00:00

av_alloc_format_context Overview Defined in avformat.h Allocates an AVFormatContext without a file. There are no av_open for output, so applications will need this. AVFormatContext *av_alloc_format_context(void); Return value A pointer to the new AVFormatContext, or NULL upon failure.

av_close_input_file

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T13:31:52+00:00

av_close_input_file Overview Defined in avformat.h Close a media file (but not its codecs). void av_close_input_file(AVFormatContext *s); Parameters s AVFormatContext *s Media file handle. Return value None See also av_open_input_file() ---------- Back to

av_find_default_stream_index

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T09:24:34+00:00

av_find_default_stream_index Overview Defined in avformat.h FIXME: Unknown! int av_find_default_stream_index(AVFormatContext *s); Parameters s AVFormatContext *s The AVFormatContext pointer to find default index in. Return value FIXME: Unknown! See also

av_find_stream_info

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T12:40:55+00:00

av_find_stream_info Overview Defined in avformat.h Read packets of a media file to get stream information. This is useful for file formats with no headers such as MPEG. This function also computes the real frame rate in case of mpeg2 repeat frame mode.

av_free

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T10:09:33+00:00

av_free Overview Defined in mem.h Free memory which has been allocated with av_malloc() or av_realloc(). NOTE: ptr = NULL is explicetly allowed NOTE2: it is recommended that you use av_freep() instead void av_free(void *ptr); Parameters ptr void *ptr The pointer to be freed.

av_freep

Anonymous (anonymous@undisclosed.example.com) — 2009-07-21T10:12:28+00:00

av_freep Overview Defined in mem.h Frees a memory block which has been allocated with av_malloc or av_realloc and set the pointer pointing to it to NULL. void av_freep(void *ptr); Parameters ptr void *ptr Pointer to the pointer to the memory block which should be freed.

av_free_packet

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T16:13:24+00:00

av_free_packet Overview Defined in avformat.h Free a packet static inline void av_free_packet(AVPacket *pkt) Parameters pkt AVPacket *pkt A pointer to the AVPacket to free. Return value None ---------- Back to ffmpeg

av_interleaved_write_frame

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:45:34+00:00

av_interleaved_write_frame Overview Defined in avformat.h Writes a packet to an output media file ensuring correct interleaving. The packet must contain one audio or video frame. If the packets are already correctly interleaved the application should call

av_new_stream

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T09:21:06+00:00

av_new_stream Overview Defined in avformat.h Add a new stream to a media file. Can only be called in the read_header() function. If the flag AVFMTCTX_NOHEADER is in the format context, then new streams can be added in av_read_packet() too. AVStream *av_new_stream(AVFormatContext *s, int id);

av_open_input_file

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T11:28:39+00:00

av_open_input_file Overview Defined in avformat.h Open a media file as input. The codecs are not opened. Only the file header (if present) is read. NOTE: If no output is desired, used av_alloc_format_context instead. int av_open_input_file(AVFormatContext **ic_ptr, const char *filename, AVInputFormat *fmt, int buf_size, AVFormatParameters *ap);

av_read_frame

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T16:03:46+00:00

avc_read_frame Overview Defined in avformat.h Return the next frame of a stream. The returned packet is valid until the next av_read_frame() or until av_close_input_file() and must be freed with av_free_packet(). For video, the packet contains exactly one frame. For audio, it contains an integer number of frames if each frame has a known fixed size (e.g. PCM or ADPCM data). If the audio frames have a variable size (e.g. MPEG audio), then it contains one frame.

av_read_packet

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T16:04:21+00:00

av_read_packet Overview OBSOLETE Defined in avformat.h Read a transport packet from a media file. This function is obsolete and should never be used. Use av_read_frame() instead. int av_read_packet(AVFormatContext *s, AVPacket *pkt);

av_register_all

Anonymous (anonymous@undisclosed.example.com) — 2007-11-22T16:18:56+00:00

av_register_all Overview Defined in avformat.h FIXME: What does this function actualy do? Initialize the library?? void av_register_all(void); Parameters None Return value None ---------- Back to ffmpeg

av_set_parameters

Anonymous (anonymous@undisclosed.example.com) — 2009-07-21T07:25:23+00:00

av_set_parameters Overview Defined in avformat.h Set the output parameters of the output video context (see output_example). Must be done even if no parameters in order to prepare the output format context. In this latter case ap may be NULL. int av_set_parameters(AVFormatContext *s, AVFormatParameters *ap);

av_write_frame

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:42:43+00:00

av_write_frame Overview Defined in avformat.h Write a packet to an output media file. The packet shall contain one audio or video frame. The packet must be correctly interleaved according to the container specification, if not then av_interleaved_write_frame must be used.

byteiocontext

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:20:55+00:00

ByteIOContext Defined in avio.h typedef struct { unsigned char *buffer; int buffer_size; unsigned char *buf_ptr, *buf_end; void *opaque; int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); int (*write_packet)(void *opaque, uint8_t *buf, int buf_size); offset_t (*seek)(void *opaque, offset_t offset, int whence); offset_t pos; /**< position in the file of the current buffer */ int must_flush; /**< true if the next seek should flush */ int eof_re…

codecid

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T09:40:32+00:00

CodecID Defined in avcodec.h /** * Identifies the syntax and semantics of the bitstream. * The principle is roughly: * Two decoders with the same ID can decode the same streams. * Two encoders with the same ID can encode compatible streams. * There may be slight deviations from the principle due to implementation * details. * * If you add a codec ID to this list, add it so that * 1. no value of a existing codec ID changes (that would break ABI), * 2. it is as close as possible to si…

codectype

Anonymous (anonymous@undisclosed.example.com) — 2007-12-31T09:21:18+00:00

CodecType Defined in avcodec.h enum CodecType { CODEC_TYPE_UNKNOWN = -1, CODEC_TYPE_VIDEO, CODEC_TYPE_AUDIO, CODEC_TYPE_DATA, CODEC_TYPE_SUBTITLE, CODEC_TYPE_NB };

codec_flag_x

Anonymous (anonymous@undisclosed.example.com) — 2008-01-02T13:03:30+00:00

Codec Flags Defined in avcodec.h #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>. #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning. /** * The parent program guarantees that the input for B-frames containing * stre…

ffmpeg

Anonymous (anonymous@undisclosed.example.com) — 2010-03-03T07:56:26+00:00

FFMPEG API Documentation Taken from avformat.h and avcodec.h and friends. Structs * AVFrame * AVPacket * AVCodecContext * AVFormatContext * AVFormatParameters * AVInputFormat * AVCodec * AVPicture * AVRational * AVOutputFormat * Url file flags * ByteIOContext * AVStream Enums * CodecType * PixelFormat * CodecID * AVERROR Flags * CODEC_FLAG_x Functions General * av_register_all() Initialize the library?? * img_convert() Convert among pixel formats…

guess_format

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T08:53:48+00:00

guess_format Overview Defined in avformat.h Guess the format based on the filename. AVOutputFormat *guess_format(const char *short_name, const char *filename, const char *mime_type); Parameters

guess_stream_format

Anonymous (anonymous@undisclosed.example.com) — 2008-02-01T08:31:49+00:00

guess_stream_format Overview Defined in avformat.h AVOutputFormat *guess_stream_format(const char *short_name, const char *filename, const char *mime_type); Parameters short_name

img_convert

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T11:00:39+00:00

img_convert Overview Defined in avcodec.h Convert among pixel formats. DEPRECATED: Use the software scaler (swscale) instead. int img_convert(AVPicture *dst, int dst_pix_fmt, const AVPicture *src, int pix_fmt, int width, int height);

output_example

Anonymous (anonymous@undisclosed.example.com) — 2009-07-21T07:18:01+00:00

output-example.c The file “libavformat/output-example.c” in the ffmpeg source tree. /* * Libavformat API example: Output a media file in any supported * libavformat format. The default codecs are used. * * Copyright (c) 2003 Fabrice Bellard * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to us…

pixelformat

Anonymous (anonymous@undisclosed.example.com) — 2007-11-26T10:39:56+00:00

PixelFormat Defined in avutil.h /** * Pixel format. Notes: * * PIX_FMT_RGB32 is handled in an endian-specific manner. A RGBA * color is put together as: * (A << 24) | (R << 16) | (G << 8) | B * This is stored as BGRA on little endian CPU architectures and ARGB on * big endian CPUs. * * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized * image data is stored in AVFrame.data[0]. The palette is transported in * AVFrame.data[1] and, is 1024 bytes long (256 4-byte …

url_fclose

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:27:24+00:00

url_fclose Overview Defined in avio.h Close a file, opened by url_fopen() int url_fclose(ByteIOContext *s); Parameters s ByteIOContext *s The ByteIOContext to close. Return value Sub zero upon failure. FIXME Is it AVERROR See also url_fopen() ---------- Back to ffmpeg

url_file_flags

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:17:56+00:00

Url File Flags Defined in avio.h #define URL_RDONLY 0 #define URL_WRONLY 1 #define URL_RDWR 2 ---------- Back to ffmpeg

url_fopen

Anonymous (anonymous@undisclosed.example.com) — 2007-12-10T13:27:36+00:00

url_fopen Overview Defined in avio.h Open a file for input, and or output. int url_fopen(ByteIOContext *s, const char *filename, int flags); Parameters s ByteIOContext *s The ByteIOContext to attach the opened file. filename