webvttdec.c File Reference

WebVTT subtitle demuxer. More...

#include "avformat.h"
#include "demux.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)
#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
const FFInputFormat	ff_webvtt_demuxer

Detailed Description

WebVTT subtitle demuxer.

See also

https://www.w3.org/TR/webvtt1/

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)

Referenced by webvtt_read_header().

OFFSET

#define OFFSET

(

x

)

Value:

offsetof(WebVTTContext, x)

Definition at line 197 of file webvttdec.c.

KIND_FLAGS

#define KIND_FLAGS   AV_OPT_FLAG_SUBTITLE_PARAM|AV_OPT_FLAG_DECODING_PARAM

Definition at line 198 of file webvttdec.c.

Function Documentation

webvtt_probe()

static int webvtt_probe ( const AVProbeData * p )

static

Definition at line 41 of file webvttdec.c.

read_ts()

static int64_t read_ts ( const char * s )

static

Definition at line 53 of file webvttdec.c.

Referenced by webvtt_read_header().

webvtt_read_header()

static int webvtt_read_header ( AVFormatContext * s )

static

Definition at line 61 of file webvttdec.c.

webvtt_read_packet()

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

static

Definition at line 176 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 182 of file webvttdec.c.

webvtt_read_close()

static int webvtt_read_close ( AVFormatContext * s )

static

Definition at line 190 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, .unit = "webvtt_kind" },
        { "subtitles",    "WebVTT subtitles kind",    0, AV_OPT_TYPE_CONST, { .i64 = 0 },                           INT_MIN, INT_MAX, KIND_FLAGS, .unit = "webvtt_kind" },
        { "captions",     "WebVTT captions kind",     0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_CAPTIONS },     INT_MIN, INT_MAX, KIND_FLAGS, .unit = "webvtt_kind" },
        { "descriptions", "WebVTT descriptions kind", 0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_DESCRIPTIONS }, INT_MIN, INT_MAX, KIND_FLAGS, .unit = "webvtt_kind" },
        { "metadata",     "WebVTT metadata kind",     0, AV_OPT_TYPE_CONST, { .i64 = AV_DISPOSITION_METADATA },     INT_MIN, INT_MAX, KIND_FLAGS, .unit = "webvtt_kind" },
    { NULL }
}

Definition at line 200 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 209 of file webvttdec.c.

ff_webvtt_demuxer

const FFInputFormat ff_webvtt_demuxer

Initial value:

= {
    .p.name         = "webvtt",
    .p.long_name    = NULL_IF_CONFIG_SMALL("WebVTT subtitle"),
    .p.mime_type    = "text/vtt",
    .p.extensions   = "vtt,webvtt",
    .p.priv_class   = &webvtt_demuxer_class,
    .priv_data_size = sizeof(WebVTTContext),
    .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
    .read_probe     = webvtt_probe,
    .read_header    = webvtt_read_header,
    .read_packet    = webvtt_read_packet,
    .read_seek2     = webvtt_read_seek,
    .read_close     = webvtt_read_close,
}

Definition at line 216 of file webvttdec.c.