small cleanup
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-session-media.h
1 /* GStreamer
2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include <gst/gst.h>
21
22 #include <gst/rtsp/gstrtsptransport.h>
23
24 #ifndef __GST_RTSP_SESSION_MEDIA_H__
25 #define __GST_RTSP_SESSION_MEDIA_H__
26
27 G_BEGIN_DECLS
28
29 #define GST_TYPE_RTSP_SESSION_MEDIA              (gst_rtsp_session_media_get_type ())
30 #define GST_IS_RTSP_SESSION_MEDIA(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SESSION_MEDIA))
31 #define GST_IS_RTSP_SESSION_MEDIA_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SESSION_MEDIA))
32 #define GST_RTSP_SESSION_MEDIA_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SESSION_MEDIA, GstRTSPSessionMediaClass))
33 #define GST_RTSP_SESSION_MEDIA(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SESSION_MEDIA, GstRTSPSessionMedia))
34 #define GST_RTSP_SESSION_MEDIA_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SESSION_MEDIA, GstRTSPSessionMediaClass))
35 #define GST_RTSP_SESSION_MEDIA_CAST(obj)         ((GstRTSPSessionMedia*)(obj))
36 #define GST_RTSP_SESSION_MEDIA_CLASS_CAST(klass) ((GstRTSPSessionMediaClass*)(klass))
37
38 typedef struct _GstRTSPSessionMedia GstRTSPSessionMedia;
39 typedef struct _GstRTSPSessionMediaClass GstRTSPSessionMediaClass;
40 typedef struct _GstRTSPSessionMediaPrivate GstRTSPSessionMediaPrivate;
41
42 /**
43  * GstRTSPSessionMedia:
44  * @url: the url of the media
45  * @media: the pipeline for the media
46  * @state: the server state
47  * @counter: counter for channels
48  * @transports: array of #GstRTSPStreamTransport with the configuration
49  *   for the transport for each selected stream from @media.
50  *
51  * State of a client session regarding a specific media identified by uri.
52  */
53 struct _GstRTSPSessionMedia
54 {
55   GObject  parent;
56
57   GstRTSPSessionMediaPrivate *priv;
58 };
59
60 struct _GstRTSPSessionMediaClass
61 {
62   GObjectClass  parent_class;
63 };
64
65 GType                    gst_rtsp_session_media_get_type       (void);
66
67 GstRTSPSessionMedia *    gst_rtsp_session_media_new            (const GstRTSPUrl *url,
68                                                                 GstRTSPMedia *media);
69
70 gboolean                 gst_rtsp_session_media_matches_url    (GstRTSPSessionMedia *media,
71                                                                 const GstRTSPUrl *url);
72 GstRTSPMedia *           gst_rtsp_session_media_get_media      (GstRTSPSessionMedia *media);
73
74 /* control media */
75 gboolean                 gst_rtsp_session_media_set_state      (GstRTSPSessionMedia *media,
76                                                                 GstState state);
77
78 void                     gst_rtsp_session_media_set_rtsp_state (GstRTSPSessionMedia *media,
79                                                                 GstRTSPState state);
80 GstRTSPState             gst_rtsp_session_media_get_rtsp_state (GstRTSPSessionMedia *media);
81
82 /* get stream transport config */
83 GstRTSPStreamTransport * gst_rtsp_session_media_set_transport  (GstRTSPSessionMedia *media,
84                                                                 GstRTSPStream *stream,
85                                                                 GstRTSPTransport *tr);
86 GstRTSPStreamTransport * gst_rtsp_session_media_get_transport  (GstRTSPSessionMedia *media,
87                                                                 guint idx);
88
89 gboolean                 gst_rtsp_session_media_alloc_channels (GstRTSPSessionMedia *media,
90                                                                 GstRTSPRange *range);
91
92 G_END_DECLS
93
94 #endif /* __GST_RTSP_SESSION_MEDIA_H__ */