GstDsdInfo

Since : 1.24

gst_dsd_info_new

GstDsdInfo *
gst_dsd_info_new ()

Allocate a new GstDsdInfo that is also initialized with gst_dsd_info_init.

Since : 1.24

gst_dsd_info_new_from_caps

GstDsdInfo *
gst_dsd_info_new_from_caps (const GstCaps * caps)

Parse caps to generate a GstDsdInfo.

Since : 1.24

gst_dsd_info_copy

GstDsdInfo *
gst_dsd_info_copy (const GstDsdInfo * info)

Copy a GstDsdInfo structure.

Since : 1.24

gst_dsd_info_free

gst_dsd_info_free (GstDsdInfo * info)

Free a GstDsdInfo structure previously allocated with gst_dsd_info_new or gst_dsd_info_copy.

Since : 1.24

gst_dsd_info_is_equal

gboolean
gst_dsd_info_is_equal (const GstDsdInfo * info,
                       const GstDsdInfo * other)

Compares two GstDsdInfo and returns whether they are equal or not

Since : 1.24

gst_dsd_info_set_format

gst_dsd_info_set_format (GstDsdInfo * info,
                         GstDsdFormat format,
                         gint rate,
                         gint channels,
                         const GstAudioChannelPosition * positions)

Set the default info for the DSD info of format and rate and channels.

Note: This initializes info first, no values are preserved.

Since : 1.24

gst_dsd_info_to_caps

GstCaps *
gst_dsd_info_to_caps (const GstDsdInfo * info)

Convert the values of info into a GstCaps.

Since : 1.24

gst_dsd_info_from_caps

gboolean
gst_dsd_info_from_caps (GstDsdInfo * info,
                        const GstCaps * caps)

Parse caps and update info.

Since : 1.24

gst_dsd_info_init

gst_dsd_info_init (GstDsdInfo * info)

Initialize info with default values.

Since : 1.24

GstDsdPlaneOffsetMeta

Since : 1.24

gst_dsd_plane_offset_meta_get_info

const GstMetaInfo *
gst_dsd_plane_offset_meta_get_info ()

gst_buffer_add_dsd_plane_offset_meta

GstDsdPlaneOffsetMeta *
gst_buffer_add_dsd_plane_offset_meta (GstBuffer * buffer,
                                      gint num_channels,
                                      gsize num_bytes_per_channel,
                                      gsize * offsets)

Allocates and attaches a GstDsdPlaneOffsetMeta on buffer, which must be writable for that purpose. The fields of the GstDsdPlaneOffsetMeta are directly populated from the arguments of this function.

If offsets is NULL, then the meta's offsets field is left uninitialized. This is useful if for example offset values are to be calculated in the meta's offsets field in-place. Similarly, num_bytes_per_channel can be set to 0, but only if offsets is NULL. This is useful if the number of bytes per channel is known only later.

It is not allowed for channels to overlap in memory, i.e. for each i in [0, channels), the range [@offsets[i], offsets[i] + num_bytes_per_channel) must not overlap with any other such range. This function will assert if the parameters specified cause this restriction to be violated.

It is, obviously, also not allowed to specify parameters that would cause out-of-bounds memory access on buffer. This is also checked, which means that you must add enough memory on the buffer before adding this meta.

This meta is only needed for non-interleaved (= planar) DSD data.

Since : 1.24

gst_dsd_convert

gst_dsd_convert (const guint8 * input_data,
                 guint8 * output_data,
                 GstDsdFormat input_format,
                 GstDsdFormat output_format,
                 GstAudioLayout input_layout,
                 GstAudioLayout output_layout,
                 const gsize * input_plane_offsets,
                 const gsize * output_plane_offsets,
                 gsize num_dsd_bytes,
                 gint num_channels,
                 gboolean reverse_byte_bits)

Converts DSD data from one layout and grouping format to another. num_bytes must be an integer multiple of the width of both input and output format. For example, if the input format is GST_DSD_FORMAT_U32LE, and the output format is GST_DSD_FORMAT_U16BE, then num_bytes must be an integer multiple of both 4 (U32LE width) and 2 (U16BE width).

reverse_byte_bits is necessary if the bit order within the DSD bytes needs to be reversed. This is rarely necessary, and is not to be confused with the endianness of formats (which determines the ordering of bytes).

input_plane_offsets must not be NULL if input_layout is set to GST_AUDIO_LAYOUT_NON_INTERLEAVED. The same applies to output_plane_offsets. These plane offsets define the starting offset of the planes (there is exactly one plane per channel) within input_data and output_data respectively. If GST_AUDIO_LAYOUT_INTERLEAVED is used, the plane offsets are ignored.

Since : 1.24

gst_dsd_plane_offset_meta_api_get_type

GType
gst_dsd_plane_offset_meta_api_get_type ()

GST_DSD_CAPS_MAKE

#define GST_DSD_CAPS_MAKE(format)                          \
  GST_DSD_MEDIA_TYPE ", "                                  \
  "format = (string) " format ", "                         \
  "rate = " GST_AUDIO_RATE_RANGE ", "                      \
  "layout = (string) { interleaved, non-interleaved }, "   \
  "reversed-bytes = (gboolean) { false, true }, "          \
  "channels = " GST_AUDIO_CHANNELS_RANGE

Generic caps string for DSD audio, for use in pad templates.

Since : 1.24

GST_DSD_INFO_CHANNELS

#define GST_DSD_INFO_CHANNELS(info)        ((info)->channels)

GST_DSD_INFO_FORMAT

#define GST_DSD_INFO_FORMAT(info)          ((info)->format)

GST_DSD_INFO_IS_VALID

#define GST_DSD_INFO_IS_VALID(i)           ((i)->format < GST_NUM_DSD_FORMATS && (i)->rate > 0 && (i)->channels > 0)

GST_DSD_INFO_LAYOUT

#define GST_DSD_INFO_LAYOUT(info)          ((info)->layout)

GST_DSD_INFO_POSITION

#define GST_DSD_INFO_POSITION(info,c)      ((info)->position[c])

GST_DSD_INFO_RATE

#define GST_DSD_INFO_RATE(info)            ((info)->rate)

GST_DSD_INFO_REVERSED_BYTES

#define GST_DSD_INFO_REVERSED_BYTES(info)  ((info)->reversed_bytes)

GST_DSD_INFO_STRIDE

#define GST_DSD_INFO_STRIDE(info)          (gst_dsd_format_get_width((info)->format) * (info)->channels)

Calculates the stride for a given GstDsdInfo.

Note that this is only useful if the info's audio layout is GST_AUDIO_LAYOUT_INTERLEAVED.

Since : 1.24

GST_DSD_MAKE_DSD_RATE_44x

#define GST_DSD_MAKE_DSD_RATE_44x(multiplier) \
    ((gint) ((gint64) multiplier) * 44100 / 8)

Calculates a valid DSD-44x rate (in bytes) from commonly used rate multiplier specifications like DSD64, DSD128 etc.

For example, to get the rate for DSD64-44x, use 64 as the multiplier argument.

Since : 1.24

GST_DSD_MAKE_DSD_RATE_48x

#define GST_DSD_MAKE_DSD_RATE_48x(multiplier) \
    ((gint) ((gint64) multiplier) * 48000 / 8)

Calculates a valid DSD-48x rate (in bytes) from commonly used rate multiplier specifications like DSD64, DSD128 etc.

For example, to get the rate for DSD64-48x, use 64 as the multiplier argument.

Since : 1.24

gst_buffer_get_dsd_plane_offset_meta

#define gst_buffer_get_dsd_plane_offset_meta(b) \
    ((GstDsdPlaneOffsetMeta*)gst_buffer_get_meta((b), GST_DSD_PLANE_OFFSET_META_API_TYPE))

GST_DSD_MEDIA_TYPE

#define GST_DSD_MEDIA_TYPE    "audio/x-dsd"

The GStreamer media type for DSD.

Since : 1.24

GST_DSD_PLANE_OFFSET_META_API_TYPE

#define GST_DSD_PLANE_OFFSET_META_API_TYPE (gst_dsd_plane_offset_meta_api_get_type())

GST_DSD_PLANE_OFFSET_META_INFO

#define GST_DSD_PLANE_OFFSET_META_INFO (gst_dsd_plane_offset_meta_get_info())

GST_DSD_SILENCE_PATTERN_BYTE

#define GST_DSD_SILENCE_PATTERN_BYTE       (0x69)

Silence pattern for DSD data.

In DSD, a nullbyte does not correspond to silence. To fill memory regions with "DSD silence", these regions must be filled with byte 0x69 instead (this is the DSD silence pattern). This constant provides that pattern in a more readable fashion.

Since : 1.24

GST_META_TAG_DSD_PLANE_OFFSETS_STR

#define GST_META_TAG_DSD_PLANE_OFFSETS_STR "dsdplaneoffsets"

This metadata stays relevant as long as the DSD plane offsets are unchanged.

Since : 1.24