FFmpeg
Main Page
Related Pages
Modules
Data Structures
Files
Examples
File List
Globals
•
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
libavfilter
buffersink.h
Go to the documentation of this file.
1
/*
2
* This file is part of FFmpeg.
3
*
4
* FFmpeg is free software; you can redistribute it and/or
5
* modify it under the terms of the GNU Lesser General Public
6
* License as published by the Free Software Foundation; either
7
* version 2.1 of the License, or (at your option) any later version.
8
*
9
* FFmpeg is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12
* Lesser General Public License for more details.
13
*
14
* You should have received a copy of the GNU Lesser General Public
15
* License along with FFmpeg; if not, write to the Free Software
16
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
*/
18
19
#ifndef AVFILTER_BUFFERSINK_H
20
#define AVFILTER_BUFFERSINK_H
21
22
/**
23
* @file
24
* memory buffer sink API for audio and video
25
*/
26
27
#include "
avfilter.h
"
28
29
/**
30
* Struct to use for initializing a buffersink context.
31
*/
32
typedef
struct
{
33
const
enum
AVPixelFormat
*
pixel_fmts
;
///< list of allowed pixel formats, terminated by AV_PIX_FMT_NONE
34
}
AVBufferSinkParams
;
35
36
/**
37
* Create an AVBufferSinkParams structure.
38
*
39
* Must be freed with av_free().
40
*/
41
AVBufferSinkParams
*
av_buffersink_params_alloc
(
void
);
42
43
/**
44
* Struct to use for initializing an abuffersink context.
45
*/
46
typedef
struct
{
47
const
enum
AVSampleFormat
*
sample_fmts
;
///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE
48
const
int64_t *
channel_layouts
;
///< list of allowed channel layouts, terminated by -1
49
}
AVABufferSinkParams
;
50
51
/**
52
* Create an AVABufferSinkParams structure.
53
*
54
* Must be freed with av_free().
55
*/
56
AVABufferSinkParams
*
av_abuffersink_params_alloc
(
void
);
57
58
/**
59
* Set the frame size for an audio buffer sink.
60
*
61
* All calls to av_buffersink_get_buffer_ref will return a buffer with
62
* exactly the specified number of samples, or AVERROR(EAGAIN) if there is
63
* not enough. The last buffer at EOF will be padded with 0.
64
*/
65
void
av_buffersink_set_frame_size
(
AVFilterContext
*ctx,
unsigned
frame_size
);
66
67
/**
68
* Tell av_buffersink_get_buffer_ref() to read video/samples buffer
69
* reference, but not remove it from the buffer. This is useful if you
70
* need only to read a video/samples buffer, without to fetch it.
71
*/
72
#define AV_BUFFERSINK_FLAG_PEEK 1
73
74
/**
75
* Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
76
* If a frame is already buffered, it is read (and removed from the buffer),
77
* but if no frame is present, return AVERROR(EAGAIN).
78
*/
79
#define AV_BUFFERSINK_FLAG_NO_REQUEST 2
80
81
/**
82
* Get an audio/video buffer data from buffer_sink and put it in bufref.
83
*
84
* This function works with both audio and video buffer sinks.
85
*
86
* @param buffer_sink pointer to a buffersink or abuffersink context
87
* @param flags a combination of AV_BUFFERSINK_FLAG_* flags
88
* @return >= 0 in case of success, a negative AVERROR code in case of
89
* failure
90
*/
91
int
av_buffersink_get_buffer_ref
(
AVFilterContext
*buffer_sink,
92
AVFilterBufferRef
**bufref,
int
flags
);
93
94
95
/**
96
* Get the number of immediately available frames.
97
*/
98
int
av_buffersink_poll_frame
(
AVFilterContext
*ctx);
99
100
/**
101
* Get the frame rate of the input.
102
*/
103
AVRational
av_buffersink_get_frame_rate
(
AVFilterContext
*ctx);
104
105
/**
106
* @defgroup libav_api Libav API
107
* @{
108
*/
109
110
/**
111
* Get a buffer with filtered data from sink and put it in buf.
112
*
113
* @param ctx pointer to a context of a buffersink or abuffersink AVFilter.
114
* @param buf pointer to the buffer will be written here if buf is non-NULL. buf
115
* must be freed by the caller using avfilter_unref_buffer().
116
* Buf may also be NULL to query whether a buffer is ready to be
117
* output.
118
*
119
* @return >= 0 in case of success, a negative AVERROR code in case of
120
* failure.
121
*/
122
int
av_buffersink_read
(
AVFilterContext
*ctx,
AVFilterBufferRef
**buf);
123
124
/**
125
* Same as av_buffersink_read, but with the ability to specify the number of
126
* samples read. This function is less efficient than av_buffersink_read(),
127
* because it copies the data around.
128
*
129
* @param ctx pointer to a context of the abuffersink AVFilter.
130
* @param buf pointer to the buffer will be written here if buf is non-NULL. buf
131
* must be freed by the caller using avfilter_unref_buffer(). buf
132
* will contain exactly nb_samples audio samples, except at the end
133
* of stream, when it can contain less than nb_samples.
134
* Buf may also be NULL to query whether a buffer is ready to be
135
* output.
136
*
137
* @warning do not mix this function with av_buffersink_read(). Use only one or
138
* the other with a single sink, not both.
139
*/
140
int
av_buffersink_read_samples
(
AVFilterContext
*ctx,
AVFilterBufferRef
**buf,
141
int
nb_samples
);
142
143
/**
144
* @}
145
*/
146
147
#endif
/* AVFILTER_BUFFERSINK_H */
Generated on Sat May 25 2013 03:58:44 for FFmpeg by
1.8.2