gstreamer/gst-libs/gst/audio/gstaudiostreamalign.h
Marijn Suijten 9ab400e267 gstaudiostreamalign: Pass self as const pointer in getter functions
It was noticed in [1] that `GstAudioStreamAlign` is a simple boxed type
that is passed as const in the copy function, but not as such in the
getters. These functions turn out to be the only users of `const = true`
overrides in `gstreamer-rs`. Since there is no locking or other advanced
caching/sharing going on (as happens with miniobjects) these functions
can safely take self as const pointer.

[1]: https://gitlab.freedesktop.org/gstreamer/gstreamer-rs/-/merge_requests/683#note_783129

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/-/merge_requests/1025>
2021-01-29 21:42:47 +01:00

92 lines
4 KiB
C

/* GStreamer
* Copyright (C) 2017 Sebastian Dröge <sebastian@centricular.com>
*
* gstaudiostreamalign.h:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_AUDIO_STREAM_ALIGN_H__
#define __GST_AUDIO_STREAM_ALIGN_H__
#include <gst/gst.h>
#include <gst/audio/audio-prelude.h>
G_BEGIN_DECLS
#define GST_TYPE_AUDIO_INFO_STREAM_ALIGN (gst_audio_stream_align_get_type ())
/**
* GstAudioStreamAlign:
*
* The opaque #GstAudioStreamAlign data structure.
*
* Since: 1.14
*/
typedef struct _GstAudioStreamAlign GstAudioStreamAlign;
GST_AUDIO_API
GType gst_audio_stream_align_get_type (void);
GST_AUDIO_API
GstAudioStreamAlign * gst_audio_stream_align_new (gint rate,
GstClockTime alignment_threshold,
GstClockTime discont_wait);
GST_AUDIO_API
GstAudioStreamAlign * gst_audio_stream_align_copy (const GstAudioStreamAlign * align);
GST_AUDIO_API
void gst_audio_stream_align_free (GstAudioStreamAlign * align);
GST_AUDIO_API
void gst_audio_stream_align_set_rate (GstAudioStreamAlign * align,
gint rate);
GST_AUDIO_API
gint gst_audio_stream_align_get_rate (const GstAudioStreamAlign * align);
GST_AUDIO_API
void gst_audio_stream_align_set_alignment_threshold (GstAudioStreamAlign * align,
GstClockTime alignment_threshold);
GST_AUDIO_API
GstClockTime gst_audio_stream_align_get_alignment_threshold (const GstAudioStreamAlign * align);
GST_AUDIO_API
void gst_audio_stream_align_set_discont_wait (GstAudioStreamAlign * align,
GstClockTime discont_wait);
GST_AUDIO_API
GstClockTime gst_audio_stream_align_get_discont_wait (const GstAudioStreamAlign * align);
GST_AUDIO_API
void gst_audio_stream_align_mark_discont (GstAudioStreamAlign * align);
GST_AUDIO_API
GstClockTime gst_audio_stream_align_get_timestamp_at_discont (const GstAudioStreamAlign * align);
GST_AUDIO_API
guint64 gst_audio_stream_align_get_samples_since_discont (const GstAudioStreamAlign * align);
GST_AUDIO_API
gboolean gst_audio_stream_align_process (GstAudioStreamAlign * align,
gboolean discont,
GstClockTime timestamp,
guint n_samples,
GstClockTime *out_timestamp,
GstClockTime *out_duration,
guint64 *out_sample_position);
G_END_DECLS
#endif /* __GST_AUDIO_STREAM_ALIGN_H__ */