pgssubdec.c File Reference

PGS subtitle decoder. More...

#include "avcodec.h"
#include "dsputil.h"
#include "bytestream.h"
#include "internal.h"
#include "libavutil/colorspace.h"
#include "libavutil/imgutils.h"
#include "libavutil/opt.h"

Go to the source code of this file.

Data Structures
struct	PGSSubPictureReference
struct	PGSSubPresentation
struct	PGSSubPicture
struct	PGSSubContext

Macros
#define	RGBA(r, g, b, a)   (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
#define	OFFSET(x)   offsetof(PGSSubContext, x)
#define	SD   AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Enumerations
enum	SegmentType {   PALETTE_SEGMENT = 0x14, PICTURE_SEGMENT = 0x15, PRESENTATION_SEGMENT = 0x16, WINDOW_SEGMENT = 0x17,   DISPLAY_SEGMENT = 0x80 }

Functions
static av_cold int	init_decoder (AVCodecContext *avctx)
static av_cold int	close_decoder (AVCodecContext *avctx)
static int	decode_rle (AVCodecContext *avctx, AVSubtitle *sub, int rect, const uint8_t *buf, unsigned int buf_size)
	Decode the RLE data.
static int	parse_picture_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size)
	Parse the picture segment packet.
static void	parse_palette_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size)
	Parse the palette segment packet.
static int	parse_presentation_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size, int64_t pts)
	Parse the presentation segment packet.
static int	display_end_segment (AVCodecContext *avctx, void *data, const uint8_t *buf, int buf_size)
	Parse the display segment packet.
static int	decode (AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)

Variables
static const AVOption	options []
static const AVClass	pgsdec_class
AVCodec	ff_pgssub_decoder

Detailed Description

PGS subtitle decoder.

Definition in file pgssubdec.c.

Macro Definition Documentation

#define RGBA	(		r,
			g,
			b,
			a
	)		(((a) << 24) | ((r) << 16) | ((g) << 8) | (b))

Definition at line 36 of file pgssubdec.c.

Referenced by parse_palette_segment().

#define OFFSET

(

x

)

offsetof(PGSSubContext, x)

Definition at line 533 of file pgssubdec.c.

#define SD   AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Definition at line 534 of file pgssubdec.c.

Enumeration Type Documentation

enum SegmentType

Enumerator:

PALETTE_SEGMENT
PICTURE_SEGMENT
PRESENTATION_SEGMENT
WINDOW_SEGMENT
DISPLAY_SEGMENT

Definition at line 38 of file pgssubdec.c.

Function Documentation

static av_cold int init_decoder ( AVCodecContext *  avctx )

static

Definition at line 76 of file pgssubdec.c.

static av_cold int close_decoder ( AVCodecContext *  avctx )

static

Definition at line 83 of file pgssubdec.c.

static int decode_rle ( AVCodecContext *  avctx, AVSubtitle *  sub, int  rect, const uint8_t *  buf, unsigned int  buf_size  )

static

Decode the RLE data.

The subtitle is stored as a Run Length Encoded image.

Parameters

avctx	contains the current codec context
sub	pointer to the processed subtitle data
buf	pointer to the RLE data to process
buf_size	size of the RLE data to process

Definition at line 110 of file pgssubdec.c.

Referenced by display_end_segment().

static int parse_picture_segment ( AVCodecContext *  avctx, const uint8_t *  buf, int  buf_size  )

static

Parse the picture segment packet.

The picture segment contains details on the sequence id, width, height and Run Length Encoded (RLE) bitmap data.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Todo:

TODO: Enable support for RLE data over multiple packets

Definition at line 177 of file pgssubdec.c.

Referenced by decode().

static void parse_palette_segment ( AVCodecContext *  avctx, const uint8_t *  buf, int  buf_size  )

static

Parse the palette segment packet.

The palette segment contains details of the palette, a maximum of 256 colors can be defined.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Definition at line 257 of file pgssubdec.c.

Referenced by decode().

static int parse_presentation_segment ( AVCodecContext *  avctx, const uint8_t *  buf, int  buf_size, int64_t  pts  )

static

Parse the presentation segment packet.

The presentation segment contains details on the video width, video height, x & y subtitle position.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Todo:

TODO: Implement cropping

Definition at line 299 of file pgssubdec.c.

Referenced by decode().

static int display_end_segment ( AVCodecContext *  avctx, void *  data, const uint8_t *  buf, int  buf_size  )

static

Parse the display segment packet.

The display segment controls the updating of the display.

Parameters

avctx	contains the current codec context
data	pointer to the data pertaining the subtitle to display
buf	pointer to the packet to process
buf_size	size of packet to process

Todo:

TODO: Fix start time, relies on correct PTS, currently too late

segment, which is currently ignored as it clears

the subtitle too early.

Todo:

TODO: Fix end time, normally cleared by a second display

Definition at line 391 of file pgssubdec.c.

Referenced by decode().

static int decode ( AVCodecContext *  avctx, void *  data, int *  data_size, AVPacket *  avpkt  )

static

Definition at line 455 of file pgssubdec.c.

Variable Documentation

const AVOption options[]

static

Initial value:

= {
    {"forced_subs_only", "Only show forced subtitles", OFFSET(forced_subs_only), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, SD},
    { NULL },
}

Definition at line 535 of file pgssubdec.c.

const AVClass pgsdec_class

static

Initial value:

= {
    .class_name = "PGS subtitle decoder",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
}

Definition at line 540 of file pgssubdec.c.

AVCodec ff_pgssub_decoder

Initial value:

= {
    .name           = "pgssub",
    .long_name      = NULL_IF_CONFIG_SMALL("HDMV Presentation Graphic Stream subtitles"),
    .type           = AVMEDIA_TYPE_SUBTITLE,
    .id             = AV_CODEC_ID_HDMV_PGS_SUBTITLE,
    .priv_data_size = sizeof(PGSSubContext),
    .init           = init_decoder,
    .close          = close_decoder,
    .decode         = decode,
    .priv_class     = &pgsdec_class,
}

Definition at line 547 of file pgssubdec.c.