FFmpeg
Data Structures | Macros | Functions | Variables
webvttdec.c File Reference
#include "avformat.h"
#include "internal.h"
#include "subtitles.h"
#include "libavutil/bprint.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/opt.h"

Go to the source code of this file.

Data Structures

struct  WebVTTContext
 

Macros

#define SET_SIDE_DATA(name, type)
 
#define OFFSET(x)   offsetof(WebVTTContext, x)
 
#define KIND_FLAGS   AV_OPT_FLAG_SUBTITLE_PARAM|AV_OPT_FLAG_DECODING_PARAM
 

Functions

static int webvtt_probe (const AVProbeData *p)
 
static int64_t read_ts (const char *s)
 
static int webvtt_read_header (AVFormatContext *s)
 
static int webvtt_read_packet (AVFormatContext *s, AVPacket *pkt)
 
static int webvtt_read_seek (AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
 
static int webvtt_read_close (AVFormatContext *s)
 

Variables

static const AVOption options []
 
static const AVClass webvtt_demuxer_class
 
AVInputFormat ff_webvtt_demuxer
 

Detailed Description

WebVTT subtitle demuxer

See also
http://dev.w3.org/html5/webvtt/

Definition in file webvttdec.c.

Macro Definition Documentation

◆ SET_SIDE_DATA

#define SET_SIDE_DATA (   name,
  type 
)
Value:
do { \
if (name##_len) { \
uint8_t *buf = av_packet_new_side_data(sub, type, name##_len); \
if (!buf) { \
res = AVERROR(ENOMEM); \
goto end; \
} \
memcpy(buf, name, name##_len); \
} \
} while (0)

◆ OFFSET

#define OFFSET (   x)    offsetof(WebVTTContext, x)

Definition at line 196 of file webvttdec.c.

◆ KIND_FLAGS

#define KIND_FLAGS   AV_OPT_FLAG_SUBTITLE_PARAM|AV_OPT_FLAG_DECODING_PARAM

Definition at line 197 of file webvttdec.c.

Function Documentation

◆ webvtt_probe()

static int webvtt_probe ( const AVProbeData *  p)
static

Definition at line 40 of file webvttdec.c.

◆ read_ts()

static int64_t read_ts ( const char *  s)
static

Definition at line 52 of file webvttdec.c.

Referenced by webvtt_read_header().

◆ webvtt_read_header()

static int webvtt_read_header ( AVFormatContext *  s)
static

Definition at line 60 of file webvttdec.c.

◆ webvtt_read_packet()

static int webvtt_read_packet ( AVFormatContext *  s,
AVPacket *  pkt 
)
static

Definition at line 175 of file webvttdec.c.

◆ webvtt_read_seek()

static int webvtt_read_seek ( AVFormatContext *  s,
int  stream_index,
int64_t  min_ts,
int64_t  ts,
int64_t  max_ts,
int  flags 
)
static

Definition at line 181 of file webvttdec.c.

◆ webvtt_read_close()

static int webvtt_read_close ( AVFormatContext *  s)
static

Definition at line 189 of file webvttdec.c.

Variable Documentation

◆ options

const AVOption options[]
static
Initial value:
= {
{ "kind", "Set kind of WebVTT track", OFFSET(kind), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, KIND_FLAGS, "webvtt_kind" },
{ "subtitles", "WebVTT subtitles kind", 0, AV_OPT_TYPE_CONST, { .i64 = 0 }, INT_MIN, INT_MAX, KIND_FLAGS, "webvtt_kind" },
{ "captions", "WebVTT captions kind", 0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_CAPTIONS }, INT_MIN, INT_MAX, KIND_FLAGS, "webvtt_kind" },
{ "descriptions", "WebVTT descriptions kind", 0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_DESCRIPTIONS }, INT_MIN, INT_MAX, KIND_FLAGS, "webvtt_kind" },
{ "metadata", "WebVTT metadata kind", 0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_METADATA }, INT_MIN, INT_MAX, KIND_FLAGS, "webvtt_kind" },
{ NULL }
}

Definition at line 199 of file webvttdec.c.

◆ webvtt_demuxer_class

const AVClass webvtt_demuxer_class
static
Initial value:
= {
.class_name = "WebVTT demuxer",
.item_name = av_default_item_name,
.option = options,
.version = LIBAVUTIL_VERSION_INT,
}

Definition at line 208 of file webvttdec.c.

◆ ff_webvtt_demuxer

AVInputFormat ff_webvtt_demuxer
Initial value:
= {
.name = "webvtt",
.long_name = NULL_IF_CONFIG_SMALL("WebVTT subtitle"),
.priv_data_size = sizeof(WebVTTContext),
.read_probe = webvtt_probe,
.read_header = webvtt_read_header,
.read_packet = webvtt_read_packet,
.read_seek2 = webvtt_read_seek,
.read_close = webvtt_read_close,
.extensions = "vtt",
.priv_class = &webvtt_demuxer_class,
}

Definition at line 215 of file webvttdec.c.

AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
WebVTTContext
Definition: webvttenc.c:31
end
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
name
const char * name
Definition: avisynth_c.h:867
OFFSET
#define OFFSET(x)
Definition: webvttdec.c:196
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
buf
void * buf
Definition: avisynth_c.h:766
av_packet_new_side_data
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
Definition: avpacket.c:329
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
NULL
#define NULL
Definition: coverity.c:32
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
KIND_FLAGS
#define KIND_FLAGS
Definition: webvttdec.c:197
AV_DISPOSITION_METADATA
#define AV_DISPOSITION_METADATA
Definition: avformat.h:852
webvtt_demuxer_class
static const AVClass webvtt_demuxer_class
Definition: webvttdec.c:208
AV_DISPOSITION_CAPTIONS
#define AV_DISPOSITION_CAPTIONS
To specify text track kind (different from subtitles default).
Definition: avformat.h:850
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:188
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AV_DISPOSITION_DESCRIPTIONS
#define AV_DISPOSITION_DESCRIPTIONS
Definition: avformat.h:851
webvtt_read_packet
static int webvtt_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: webvttdec.c:175
options
static const AVOption options[]
Definition: webvttdec.c:199
webvtt_read_close
static int webvtt_read_close(AVFormatContext *s)
Definition: webvttdec.c:189
webvtt_probe
static int webvtt_probe(const AVProbeData *p)
Definition: webvttdec.c:40
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
webvtt_read_seek
static int webvtt_read_seek(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
Definition: webvttdec.c:181
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:232
webvtt_read_header
static int webvtt_read_header(AVFormatContext *s)
Definition: webvttdec.c:60
Generated on Wed Aug 24 2022 21:27:40 for FFmpeg by   doxygen 1.8.17