Blame docs/libs/html/gst-plugins-base-libs-Riff-utilities.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>Riff utilities: GStreamer Base Plugins 1.0 Library Reference Manual</title>
Packit 971217
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 971217
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
Packit 971217
<link rel="up" href="gstreamer-riff.html" title="Riff Media Library">
Packit 971217
<link rel="prev" href="gstreamer-riff.html" title="Riff Media Library">
Packit 971217
<link rel="next" href="gstreamer-rtp.html" title="RTP Library">
Packit 971217
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 971217
<link rel="stylesheet" href="style.css" type="text/css">
Packit 971217
</head>
Packit 971217
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 971217
Packit 971217
Packit 971217
Top  | 
Packit 971217
                  Description
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Riff utilities

Packit 971217

Riff utilities — Riff fileformat utillity functions.

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_audio_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_audio_template_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_iavs_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_iavs_template_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_video_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstCaps *
Packit 971217
Packit 971217
Packit 971217
gst_riff_create_video_template_caps ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_riff_init ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_chunk ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_file_header ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_info ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_strf_auds ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_strf_iavs ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_strf_vids ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_riff_parse_strh ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstFlowReturn
Packit 971217
Packit 971217
Packit 971217
gst_riff_read_chunk ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

Packit 971217
#include <gst/riff/riff-media.h>
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

A collection of functions to handle riff base files, such as avi, wav and

Packit 971217
asf.

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

gst_riff_create_audio_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_audio_caps (guint16 codec_id,
Packit 971217
                            gst_riff_strh *strh,
Packit 971217
                            gst_riff_strf_auds *strf,
Packit 971217
                            GstBuffer *strf_data,
Packit 971217
                            GstBuffer *strd_data,
Packit 971217
                            char **codec_name,
Packit 971217
                            gint channel_reorder_map[18]);
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_create_audio_template_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_audio_template_caps (void);
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_create_iavs_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_iavs_caps (guint32 codec_fcc,
Packit 971217
                           gst_riff_strh *strh,
Packit 971217
                           gst_riff_strf_iavs *strf,
Packit 971217
                           GstBuffer *strf_data,
Packit 971217
                           GstBuffer *strd_data,
Packit 971217
                           char **codec_name);
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_create_iavs_template_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_iavs_template_caps (void);
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_create_video_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_video_caps (guint32 codec_fcc,
Packit 971217
                            gst_riff_strh *strh,
Packit 971217
                            gst_riff_strf_vids *strf,
Packit 971217
                            GstBuffer *strf_data,
Packit 971217
                            GstBuffer *strd_data,
Packit 971217
                            char **codec_name);
Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

codec_fcc

Packit 971217

fourCC codec for this codec.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strh

Packit 971217

pointer to the strh stream header structure.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strf

Packit 971217

pointer to the strf stream header structure, including any

Packit 971217
data that is within the range of strf.size, but excluding any
Packit 971217
additional data withint this chunk but outside strf.size.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strf_data

Packit 971217

a GstBuffer containing the additional data in the strf

Packit 971217
chunk outside reach of strf.size. Ususally a palette.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strd_data

Packit 971217

a GstBuffer containing the data in the strd stream header

Packit 971217
chunk. Usually codec initialization data.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

codec_name

Packit 971217

if given, will be filled with a human-readable codec name.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_create_video_template_caps ()

Packit 971217
GstCaps *
Packit 971217
gst_riff_create_video_template_caps (void);
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_init ()

Packit 971217
void
Packit 971217
gst_riff_init (void);
Packit 971217

Initialize riff library.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_chunk ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_chunk (GstElement *element,
Packit 971217
                      GstBuffer *buf,
Packit 971217
                      guint *offset,
Packit 971217
                      guint32 *fourcc,
Packit 971217
                      GstBuffer **chunk_data);
Packit 971217

Reads a single chunk.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input buffer.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

offset

Packit 971217

offset in the buffer in the caller. Is incremented

Packit 971217
by the read size by this function.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

fourcc

Packit 971217

fourcc (returned by this function0 of the chunk.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

chunk_data

Packit 971217

buffer (returned by the function) containing the

Packit 971217
chunk data, which may be NULL if chunksize == 0

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

FALSE on error, TRUE otherwise

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_file_header ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_file_header (GstElement *element,
Packit 971217
                            GstBuffer *buf,
Packit 971217
                            guint32 *doctype);
Packit 971217

Reads the first few bytes from the provided buffer, checks

Packit 971217
if this stream is a RIFF stream, and determines document type.
Packit 971217
This function takes ownership of buf
Packit 971217
 so it should not be used anymore
Packit 971217
after calling this function.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input buffer from which the file header will be parsed,

Packit 971217
should be at least 12 bytes long.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

doctype

Packit 971217

a fourcc (returned by this function) to indicate the

Packit 971217
type of document (according to the header).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

FALSE if this is not a RIFF stream (in which case the

Packit 971217
caller should error out; we already throw an error), or TRUE
Packit 971217
if it is.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_info ()

Packit 971217
void
Packit 971217
gst_riff_parse_info (GstElement *element,
Packit 971217
                     GstBuffer *buf,
Packit 971217
                     GstTagList **taglist);
Packit 971217

Parses stream metadata from input data.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input data to be used for parsing, stripped from header.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

taglist

Packit 971217

a pointer to a taglist (returned by this function)

Packit 971217
containing information about this stream. May be
Packit 971217
NULL if no supported tags were found.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_strf_auds ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_strf_auds (GstElement *element,
Packit 971217
                          GstBuffer *buf,
Packit 971217
                          gst_riff_strf_auds **strf,
Packit 971217
                          GstBuffer **data);
Packit 971217

Parses an audio stream's strf structure plus optionally some

Packit 971217
extradata from input data. This function takes ownership of buf
Packit 971217
.
Packit 971217
use.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input data to be used for parsing, stripped from header.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strf

Packit 971217

a pointer (returned by this function) to a filled-in

Packit 971217
strf/auds structure. Caller should free it.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

data

Packit 971217

a pointer (returned by this function) to a buffer

Packit 971217
containing extradata for this particular stream (e.g.
Packit 971217
codec initialization data).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE if parsing succeeded, otherwise FALSE. The stream

Packit 971217
should be skipped on error, but it is not fatal.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_strf_iavs ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_strf_iavs (GstElement *element,
Packit 971217
                          GstBuffer *buf,
Packit 971217
                          gst_riff_strf_iavs **strf,
Packit 971217
                          GstBuffer **data);
Packit 971217

Parses a interleaved (also known as "complex") stream´s strf

Packit 971217
structure plus optionally some extradata from input data. This
Packit 971217
function takes ownership of buf
Packit 971217
.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input data to be used for parsing, stripped from header.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strf

Packit 971217

a pointer (returned by this function) to a filled-in

Packit 971217
strf/iavs structure. Caller should free it.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

data

Packit 971217

a pointer (returned by this function) to a buffer

Packit 971217
containing extradata for this particular stream (e.g.
Packit 971217
codec initialization data).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE if parsing succeeded, otherwise FALSE.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_strf_vids ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_strf_vids (GstElement *element,
Packit 971217
                          GstBuffer *buf,
Packit 971217
                          gst_riff_strf_vids **strf,
Packit 971217
                          GstBuffer **data);
Packit 971217

Parses a video stream's strf structure plus optionally some

Packit 971217
extradata from input data. This function takes ownership of buf
Packit 971217
.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input data to be used for parsing, stripped from header.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strf

Packit 971217

a pointer (returned by this function) to a filled-in

Packit 971217
strf/vids structure. Caller should free it.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

data

Packit 971217

a pointer (returned by this function) to a buffer

Packit 971217
containing extradata for this particular stream (e.g.
Packit 971217
palette, codec initialization data).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE if parsing succeeded, otherwise FALSE. The stream

Packit 971217
should be skipped on error, but it is not fatal.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_parse_strh ()

Packit 971217
gboolean
Packit 971217
gst_riff_parse_strh (GstElement *element,
Packit 971217
                     GstBuffer *buf,
Packit 971217
                     gst_riff_strh **strh);
Packit 971217

Parses a strh structure from input data. Takes ownership of buf

Packit 971217
.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging/error).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

buf

Packit 971217

input data to be used for parsing, stripped from header.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

strh

Packit 971217

a pointer (returned by this function) to a filled-in

Packit 971217
strh structure. Caller should free it.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE if parsing succeeded, otherwise FALSE. The stream

Packit 971217
should be skipped on error, but it is not fatal.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_riff_read_chunk ()

Packit 971217
GstFlowReturn
Packit 971217
gst_riff_read_chunk (GstElement *element,
Packit 971217
                     GstPad *pad,
Packit 971217
                     guint64 *offset,
Packit 971217
                     guint32 *tag,
Packit 971217
                     GstBuffer **chunk_data);
Packit 971217

Reads a single chunk of data. 'JUNK' chunks are skipped

Packit 971217
automatically.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

element

Packit 971217

caller element (used for debugging).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

pad

Packit 971217

pad to pull data from.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

offset

Packit 971217

offset to pull from, incremented by this function.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

tag

Packit 971217

fourcc of the chunk (returned by this function).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

chunk_data

Packit 971217

buffer (returned by this function).

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

flow status.

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Generated by GTK-Doc V1.27
Packit 971217
</body>
Packit 971217
</html>