gstreamer/gst-libs/gst/play/gstplay-media-info.h
Stephan Hesse a74651ddc1 play: Introducing the new playback library
This aims to be a replacement for the GstPlayer library. In GstPlay, notifications are
sent as application messages through a dedicated GstBus. The GMainContext-based
signal dispatcher was replaced by a GObject signal adapter, now relying on the
bus to emit its signals. The signal dispatcher is now optional and fully
decoupled from the GstPlay object.

Co-authored with: Philippe Normand <philn@igalia.com>

Fixes #394

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/2061>
2021-03-09 18:03:48 +00:00

281 lines
9.2 KiB
C

/* GStreamer
*
* Copyright (C) 2015 Brijesh Singh <brijesh.ksingh@gmail.com>
*
* 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_PLAY_MEDIA_INFO_H__
#define __GST_PLAY_MEDIA_INFO_H__
#include <gst/gst.h>
#include <gst/play/play-prelude.h>
G_BEGIN_DECLS
/**
* GST_TYPE_PLAY_STREAM_INFO:
* Since: 1.20
*/
#define GST_TYPE_PLAY_STREAM_INFO \
(gst_play_stream_info_get_type ())
#define GST_PLAY_STREAM_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_STREAM_INFO,GstPlayStreamInfo))
#define GST_PLAY_STREAM_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_STREAM_INFO,GstPlayStreamInfo))
#define GST_IS_PLAY_STREAM_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_STREAM_INFO))
#define GST_IS_PLAY_STREAM_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_STREAM_INFO))
/**
* GstPlayStreamInfo:
*
* Base structure for information concerning a media stream. Depending on
* the stream type, one can find more media-specific information in
* #GstPlayVideoInfo, #GstPlayAudioInfo, #GstPlaySubtitleInfo.
* Since: 1.20
*/
typedef struct _GstPlayStreamInfo GstPlayStreamInfo;
typedef struct _GstPlayStreamInfoClass GstPlayStreamInfoClass;
GST_PLAY_API
GType gst_play_stream_info_get_type (void);
GST_PLAY_API
gint gst_play_stream_info_get_index (const GstPlayStreamInfo *info);
GST_PLAY_API
const gchar* gst_play_stream_info_get_stream_type (const GstPlayStreamInfo *info);
GST_PLAY_API
GstTagList* gst_play_stream_info_get_tags (const GstPlayStreamInfo *info);
GST_PLAY_API
GstCaps* gst_play_stream_info_get_caps (const GstPlayStreamInfo *info);
GST_PLAY_API
const gchar* gst_play_stream_info_get_codec (const GstPlayStreamInfo *info);
/**
* GST_TYPE_PLAY_VIDEO_INFO:
* Since: 1.20
*/
#define GST_TYPE_PLAY_VIDEO_INFO \
(gst_play_video_info_get_type ())
#define GST_PLAY_VIDEO_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_VIDEO_INFO, GstPlayVideoInfo))
#define GST_PLAY_VIDEO_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((obj),GST_TYPE_PLAY_VIDEO_INFO, GstPlayVideoInfoClass))
#define GST_IS_PLAY_VIDEO_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_VIDEO_INFO))
#define GST_IS_PLAY_VIDEO_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((obj),GST_TYPE_PLAY_VIDEO_INFO))
/**
* GstPlayVideoInfo:
*
* #GstPlayStreamInfo specific to video streams.
* Since: 1.20
*/
typedef struct _GstPlayVideoInfo GstPlayVideoInfo;
typedef struct _GstPlayVideoInfoClass GstPlayVideoInfoClass;
GST_PLAY_API
GType gst_play_video_info_get_type (void);
GST_PLAY_API
gint gst_play_video_info_get_bitrate (const GstPlayVideoInfo * info);
GST_PLAY_API
gint gst_play_video_info_get_max_bitrate (const GstPlayVideoInfo * info);
GST_PLAY_API
gint gst_play_video_info_get_width (const GstPlayVideoInfo * info);
GST_PLAY_API
gint gst_play_video_info_get_height (const GstPlayVideoInfo * info);
GST_PLAY_API
void gst_play_video_info_get_framerate (const GstPlayVideoInfo * info,
gint * fps_n,
gint * fps_d);
GST_PLAY_API
void gst_play_video_info_get_pixel_aspect_ratio (const GstPlayVideoInfo * info,
guint * par_n,
guint * par_d);
/**
* GST_TYPE_PLAY_AUDIO_INFO:
* Since: 1.20
*/
#define GST_TYPE_PLAY_AUDIO_INFO \
(gst_play_audio_info_get_type ())
#define GST_PLAY_AUDIO_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_AUDIO_INFO, GstPlayAudioInfo))
#define GST_PLAY_AUDIO_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_AUDIO_INFO, GstPlayAudioInfoClass))
#define GST_IS_PLAY_AUDIO_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_AUDIO_INFO))
#define GST_IS_PLAY_AUDIO_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_AUDIO_INFO))
/**
* GstPlayAudioInfo:
*
* #GstPlayStreamInfo specific to audio streams.
* Since: 1.20
*/
typedef struct _GstPlayAudioInfo GstPlayAudioInfo;
typedef struct _GstPlayAudioInfoClass GstPlayAudioInfoClass;
GST_PLAY_API
GType gst_play_audio_info_get_type (void);
GST_PLAY_API
gint gst_play_audio_info_get_channels (const GstPlayAudioInfo* info);
GST_PLAY_API
gint gst_play_audio_info_get_sample_rate (const GstPlayAudioInfo* info);
GST_PLAY_API
gint gst_play_audio_info_get_bitrate (const GstPlayAudioInfo* info);
GST_PLAY_API
gint gst_play_audio_info_get_max_bitrate (const GstPlayAudioInfo* info);
GST_PLAY_API
const gchar* gst_play_audio_info_get_language (const GstPlayAudioInfo* info);
/**
* GST_TYPE_PLAY_SUBTITLE_INFO:
* Since: 1.20
*/
#define GST_TYPE_PLAY_SUBTITLE_INFO \
(gst_play_subtitle_info_get_type ())
#define GST_PLAY_SUBTITLE_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_SUBTITLE_INFO, GstPlaySubtitleInfo))
#define GST_PLAY_SUBTITLE_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_SUBTITLE_INFO,GstPlaySubtitleInfoClass))
#define GST_IS_PLAY_SUBTITLE_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_SUBTITLE_INFO))
#define GST_IS_PLAY_SUBTITLE_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_SUBTITLE_INFO))
/**
* GstPlaySubtitleInfo:
*
* #GstPlayStreamInfo specific to subtitle streams.
* Since: 1.20
*/
typedef struct _GstPlaySubtitleInfo GstPlaySubtitleInfo;
typedef struct _GstPlaySubtitleInfoClass GstPlaySubtitleInfoClass;
GST_PLAY_API
GType gst_play_subtitle_info_get_type (void);
GST_PLAY_API
const gchar * gst_play_subtitle_info_get_language (const GstPlaySubtitleInfo* info);
/**
* GST_TYPE_PLAY_MEDIA_INFO:
* Since: 1.20
*/
#define GST_TYPE_PLAY_MEDIA_INFO \
(gst_play_media_info_get_type())
#define GST_PLAY_MEDIA_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_MEDIA_INFO,GstPlayMediaInfo))
#define GST_PLAY_MEDIA_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_MEDIA_INFO,GstPlayMediaInfoClass))
#define GST_IS_PLAY_MEDIA_INFO(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_MEDIA_INFO))
#define GST_IS_PLAY_MEDIA_INFO_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_MEDIA_INFO))
/**
* GstPlayMediaInfo:
*
* Structure containing the media information of a URI.
* Since: 1.20
*/
typedef struct _GstPlayMediaInfo GstPlayMediaInfo;
typedef struct _GstPlayMediaInfoClass GstPlayMediaInfoClass;
GST_PLAY_API
GType gst_play_media_info_get_type (void);
GST_PLAY_API
const gchar * gst_play_media_info_get_uri (const GstPlayMediaInfo *info);
GST_PLAY_API
gboolean gst_play_media_info_is_seekable (const GstPlayMediaInfo *info);
GST_PLAY_API
gboolean gst_play_media_info_is_live (const GstPlayMediaInfo *info);
GST_PLAY_API
GstClockTime gst_play_media_info_get_duration (const GstPlayMediaInfo *info);
GST_PLAY_API
GList* gst_play_media_info_get_stream_list (const GstPlayMediaInfo *info);
GST_PLAY_API
guint gst_play_media_info_get_number_of_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
GList* gst_play_media_info_get_video_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
guint gst_play_media_info_get_number_of_video_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
GList* gst_play_media_info_get_audio_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
guint gst_play_media_info_get_number_of_audio_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
GList* gst_play_media_info_get_subtitle_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
guint gst_play_media_info_get_number_of_subtitle_streams (const GstPlayMediaInfo *info);
GST_PLAY_API
GstTagList* gst_play_media_info_get_tags (const GstPlayMediaInfo *info);
GST_PLAY_API
const gchar* gst_play_media_info_get_title (const GstPlayMediaInfo *info);
GST_PLAY_API
const gchar* gst_play_media_info_get_container_format (const GstPlayMediaInfo *info);
GST_PLAY_API
GstSample* gst_play_media_info_get_image_sample (const GstPlayMediaInfo *info);
GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_video_streams)
GList* gst_play_get_video_streams (const GstPlayMediaInfo *info);
GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_audio_streams)
GList* gst_play_get_audio_streams (const GstPlayMediaInfo *info);
GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_subtitle_streams)
GList* gst_play_get_subtitle_streams (const GstPlayMediaInfo *info);
G_END_DECLS
#endif /* __GST_PLAY_MEDIA_INFO_H */