2 * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
3 * <2006> Lutz Mueller <lutz at topfrose dot de>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 * Unless otherwise indicated, Source Code is licensed under MIT license.
22 * See further explanation attached in License Statement (distributed in the file
25 * Permission is hereby granted, free of charge, to any person obtaining a copy of
26 * this software and associated documentation files (the "Software"), to deal in
27 * the Software without restriction, including without limitation the rights to
28 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
29 * of the Software, and to permit persons to whom the Software is furnished to do
30 * so, subject to the following conditions:
32 * The above copyright notice and this permission notice shall be included in all
33 * copies or substantial portions of the Software.
35 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
36 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
37 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
38 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
39 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
40 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45 * SECTION:gstrtspmessage
46 * @short_description: RTSP messages
47 * @see_also: gstrtspconnection
51 * Provides methods for creating and parsing request, response and data messages.
55 * Last reviewed on 2007-07-25 (0.10.14)
60 #include "gstrtspmessage.h"
62 typedef struct _RTSPKeyValue
64 GstRTSPHeaderField field;
69 key_value_foreach (GArray * array, GFunc func, gpointer user_data)
73 g_return_if_fail (array != NULL);
75 for (i = 0; i < array->len; i++) {
76 (*func) (&g_array_index (array, RTSPKeyValue, i), user_data);
81 * gst_rtsp_message_new:
82 * @msg: a location for the new #GstRTSPMessage
84 * Create a new initialized #GstRTSPMessage.
86 * Returns: a #GstRTSPResult. Free with gst_rtsp_message_free().
89 gst_rtsp_message_new (GstRTSPMessage ** msg)
91 GstRTSPMessage *newmsg;
93 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
95 newmsg = g_new0 (GstRTSPMessage, 1);
99 return gst_rtsp_message_init (newmsg);
103 * gst_rtsp_message_init:
104 * @msg: a #GstRTSPMessage
106 * Initialize @msg. This function is mostly used when @msg is allocated on the
107 * stack. The reverse operation of this is gst_rtsp_message_unset().
109 * Returns: a #GstRTSPResult.
112 gst_rtsp_message_init (GstRTSPMessage * msg)
114 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
116 gst_rtsp_message_unset (msg);
118 msg->type = GST_RTSP_MESSAGE_INVALID;
119 msg->hdr_fields = g_array_new (FALSE, FALSE, sizeof (RTSPKeyValue));
125 * gst_rtsp_message_get_type:
126 * @msg: a #GstRTSPMessage
128 * Get the message type of @msg.
130 * Returns: the message type.
133 gst_rtsp_message_get_type (GstRTSPMessage * msg)
135 g_return_val_if_fail (msg != NULL, GST_RTSP_MESSAGE_INVALID);
141 * gst_rtsp_message_new_request:
142 * @msg: a location for the new #GstRTSPMessage
143 * @method: the request method to use
144 * @uri: the uri of the request
146 * Create a new #GstRTSPMessage with @method and @uri and store the result
147 * request message in @msg.
149 * Returns: a #GstRTSPResult. Free with gst_rtsp_message_free().
152 gst_rtsp_message_new_request (GstRTSPMessage ** msg, GstRTSPMethod method,
155 GstRTSPMessage *newmsg;
157 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
158 g_return_val_if_fail (uri != NULL, GST_RTSP_EINVAL);
160 newmsg = g_new0 (GstRTSPMessage, 1);
164 return gst_rtsp_message_init_request (newmsg, method, uri);
168 * gst_rtsp_message_init_request:
169 * @msg: a #GstRTSPMessage
170 * @method: the request method to use
171 * @uri: the uri of the request
173 * Initialize @msg as a request message with @method and @uri. To clear @msg
174 * again, use gst_rtsp_message_unset().
176 * Returns: a #GstRTSPResult.
179 gst_rtsp_message_init_request (GstRTSPMessage * msg, GstRTSPMethod method,
182 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
183 g_return_val_if_fail (uri != NULL, GST_RTSP_EINVAL);
185 gst_rtsp_message_unset (msg);
187 msg->type = GST_RTSP_MESSAGE_REQUEST;
188 msg->type_data.request.method = method;
189 msg->type_data.request.uri = g_strdup (uri);
190 msg->type_data.request.version = GST_RTSP_VERSION_1_0;
191 msg->hdr_fields = g_array_new (FALSE, FALSE, sizeof (RTSPKeyValue));
197 * gst_rtsp_message_parse_request:
198 * @msg: a #GstRTSPMessage
199 * @method: location to hold the method
200 * @uri: location to hold the uri
201 * @version: location to hold the version
203 * Parse the request message @msg and store the values @method, @uri and
204 * @version. The result locations can be #NULL if one is not interested in its
207 * @uri remains valid for as long as @msg is valid and unchanged.
209 * Returns: a #GstRTSPResult.
212 gst_rtsp_message_parse_request (GstRTSPMessage * msg,
213 GstRTSPMethod * method, const gchar ** uri, GstRTSPVersion * version)
215 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
216 g_return_val_if_fail (msg->type != GST_RTSP_MESSAGE_REQUEST, GST_RTSP_EINVAL);
219 *method = msg->type_data.request.method;
221 *uri = msg->type_data.request.uri;
223 *version = msg->type_data.request.version;
229 * gst_rtsp_message_new_response:
230 * @msg: a location for the new #GstRTSPMessage
231 * @code: the status code
232 * @reason: the status reason or #NULL
233 * @request: the request that triggered the response or #NULL
235 * Create a new response #GstRTSPMessage with @code and @reason and store the
236 * result message in @msg.
238 * When @reason is #NULL, the default reason for @code will be used.
240 * When @request is not #NULL, the relevant headers will be copied to the new
243 * Returns: a #GstRTSPResult. Free with gst_rtsp_message_free().
246 gst_rtsp_message_new_response (GstRTSPMessage ** msg, GstRTSPStatusCode code,
247 const gchar * reason, const GstRTSPMessage * request)
249 GstRTSPMessage *newmsg;
251 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
253 newmsg = g_new0 (GstRTSPMessage, 1);
257 return gst_rtsp_message_init_response (newmsg, code, reason, request);
261 * gst_rtsp_message_init_response:
262 * @msg: a #GstRTSPMessage
263 * @code: the status code
264 * @reason: the status reason or #NULL
265 * @request: the request that triggered the response or #NULL
267 * Initialize @msg with @code and @reason.
269 * When @reason is #NULL, the default reason for @code will be used.
271 * When @request is not #NULL, the relevant headers will be copied to the new
274 * Returns: a #GstRTSPResult.
277 gst_rtsp_message_init_response (GstRTSPMessage * msg, GstRTSPStatusCode code,
278 const gchar * reason, const GstRTSPMessage * request)
280 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
282 gst_rtsp_message_unset (msg);
285 reason = gst_rtsp_status_as_text (code);
287 msg->type = GST_RTSP_MESSAGE_RESPONSE;
288 msg->type_data.response.code = code;
289 msg->type_data.response.reason = g_strdup (reason);
290 msg->type_data.response.version = GST_RTSP_VERSION_1_0;
291 msg->hdr_fields = g_array_new (FALSE, FALSE, sizeof (RTSPKeyValue));
297 if (gst_rtsp_message_get_header (request, GST_RTSP_HDR_CSEQ, &header,
299 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CSEQ, header);
302 /* copy session id */
303 if (gst_rtsp_message_get_header (request, GST_RTSP_HDR_SESSION, &header,
307 header = g_strdup (header);
308 if ((pos = strchr (header, ';'))) {
312 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_SESSION, header);
316 /* FIXME copy more headers? */
324 * gst_rtsp_message_parse_response:
325 * @msg: a #GstRTSPMessage
326 * @code: location to hold the status code
327 * @reason: location to hold the status reason
328 * @version: location to hold the version
330 * Parse the response message @msg and store the values @code, @reason and
331 * @version. The result locations can be #NULL if one is not interested in its
334 * @reason remains valid for as long as @msg is valid and unchanged.
336 * Returns: a #GstRTSPResult.
339 gst_rtsp_message_parse_response (GstRTSPMessage * msg,
340 GstRTSPStatusCode * code, const gchar ** reason, GstRTSPVersion * version)
342 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
343 g_return_val_if_fail (msg->type != GST_RTSP_MESSAGE_RESPONSE,
347 *code = msg->type_data.response.code;
349 *reason = msg->type_data.response.reason;
351 *version = msg->type_data.response.version;
357 * gst_rtsp_message_new_data:
358 * @msg: a location for the new #GstRTSPMessage
359 * @channel: the channel
361 * Create a new data #GstRTSPMessage with @channel and store the
362 * result message in @msg.
364 * Returns: a #GstRTSPResult. Free with gst_rtsp_message_free().
367 gst_rtsp_message_new_data (GstRTSPMessage ** msg, guint8 channel)
369 GstRTSPMessage *newmsg;
371 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
373 newmsg = g_new0 (GstRTSPMessage, 1);
377 return gst_rtsp_message_init_data (newmsg, channel);
381 * gst_rtsp_message_init_data:
382 * @msg: a #GstRTSPMessage
383 * @channel: a channel
385 * Initialize a new data #GstRTSPMessage for @channel.
387 * Returns: a #GstRTSPResult.
390 gst_rtsp_message_init_data (GstRTSPMessage * msg, guint8 channel)
392 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
394 gst_rtsp_message_unset (msg);
396 msg->type = GST_RTSP_MESSAGE_DATA;
397 msg->type_data.data.channel = channel;
403 * gst_rtsp_message_parse_data:
404 * @msg: a #GstRTSPMessage
405 * @channel: location to hold the channel
407 * Parse the data message @msg and store the channel in @channel.
409 * Returns: a #GstRTSPResult.
412 gst_rtsp_message_parse_data (GstRTSPMessage * msg, guint8 * channel)
414 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
415 g_return_val_if_fail (msg->type != GST_RTSP_MESSAGE_DATA, GST_RTSP_EINVAL);
418 *channel = msg->type_data.data.channel;
424 * gst_rtsp_message_unset:
425 * @msg: a #GstRTSPMessage
427 * Unset the concents of @msg so that it becomes an uninitialized
428 * #GstRTSPMessage again. This function is mostly used in combination with
429 * gst_rtsp_message_init_request(), gst_rtsp_message_init_response() and
430 * gst_rtsp_message_init_data() on stack allocated #GstRTSPMessage structures.
432 * Returns: #GST_RTSP_OK.
435 gst_rtsp_message_unset (GstRTSPMessage * msg)
437 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
440 case GST_RTSP_MESSAGE_INVALID:
442 case GST_RTSP_MESSAGE_REQUEST:
443 g_free (msg->type_data.request.uri);
445 case GST_RTSP_MESSAGE_RESPONSE:
446 g_free (msg->type_data.response.reason);
448 case GST_RTSP_MESSAGE_DATA:
451 g_return_val_if_reached (GST_RTSP_EINVAL);
454 if (msg->hdr_fields != NULL) {
457 for (i = 0; i < msg->hdr_fields->len; i++) {
458 RTSPKeyValue *keyval = &g_array_index (msg->hdr_fields, RTSPKeyValue, i);
460 g_free (keyval->value);
462 g_array_free (msg->hdr_fields, TRUE);
466 memset (msg, 0, sizeof *msg);
472 * gst_rtsp_message_free:
473 * @msg: a #GstRTSPMessage
475 * Free the memory used by @msg.
477 * Returns: a #GstRTSPResult.
480 gst_rtsp_message_free (GstRTSPMessage * msg)
484 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
486 res = gst_rtsp_message_unset (msg);
487 if (res == GST_RTSP_OK)
494 * gst_rtsp_message_add_header:
495 * @msg: a #GstRTSPMessage
496 * @field: a #GstRTSPHeaderField
497 * @value: the value of the header
499 * Add a header with key @field and @value to @msg.
501 * Returns: a #GstRTSPResult.
504 gst_rtsp_message_add_header (GstRTSPMessage * msg, GstRTSPHeaderField field,
507 RTSPKeyValue key_value;
509 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
510 g_return_val_if_fail (value != NULL, GST_RTSP_EINVAL);
512 key_value.field = field;
513 key_value.value = g_strdup (value);
515 g_array_append_val (msg->hdr_fields, key_value);
521 * gst_rtsp_message_remove_header:
522 * @msg: a #GstRTSPMessage
523 * @field: a #GstRTSPHeaderField
524 * @indx: the index of the header
526 * Remove the @indx header with key @field from @msg. If @indx equals -1, all
527 * headers will be removed.
529 * Returns: a #GstRTSPResult.
532 gst_rtsp_message_remove_header (GstRTSPMessage * msg, GstRTSPHeaderField field,
535 GstRTSPResult res = GST_RTSP_ENOTIMPL;
539 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
541 while (i < msg->hdr_fields->len) {
542 RTSPKeyValue key_value = g_array_index (msg->hdr_fields, RTSPKeyValue, i);
544 if (key_value.field == field && (indx == -1 || cnt++ == indx)) {
545 g_array_remove_index (msg->hdr_fields, i);
557 * gst_rtsp_message_get_header:
558 * @msg: a #GstRTSPMessage
559 * @field: a #GstRTSPHeaderField
560 * @value: pointer to hold the result
561 * @indx: the index of the header
563 * Get the @indx header value with key @field from @msg.
565 * Returns: #GST_RTSP_OK when @field was found, #GST_RTSP_ENOTIMPL if the key
569 gst_rtsp_message_get_header (const GstRTSPMessage * msg,
570 GstRTSPHeaderField field, gchar ** value, gint indx)
575 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
577 for (i = 0; i < msg->hdr_fields->len; i++) {
578 RTSPKeyValue key_value = g_array_index (msg->hdr_fields, RTSPKeyValue, i);
580 if (key_value.field == field && cnt++ == indx) {
582 *value = key_value.value;
587 return GST_RTSP_ENOTIMPL;
591 * gst_rtsp_message_append_headers:
592 * @msg: a #GstRTSPMessage
595 * Append the currently configured headers in @msg to the #GString @str suitable
598 * Returns: #GST_RTSP_OK.
601 gst_rtsp_message_append_headers (const GstRTSPMessage * msg, GString * str)
605 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
606 g_return_val_if_fail (str != NULL, GST_RTSP_EINVAL);
608 for (i = 0; i < msg->hdr_fields->len; i++) {
609 RTSPKeyValue key_value = g_array_index (msg->hdr_fields, RTSPKeyValue, i);
610 const gchar *keystr = gst_rtsp_header_as_text (key_value.field);
612 g_string_append_printf (str, "%s: %s\r\n", keystr, key_value.value);
618 * gst_rtsp_message_set_body:
619 * @msg: a #GstRTSPMessage
621 * @size: the size of @data
623 * Set the body of @msg to a copy of @data.
625 * Returns: #GST_RTSP_OK.
628 gst_rtsp_message_set_body (GstRTSPMessage * msg, const guint8 * data,
631 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
633 return gst_rtsp_message_take_body (msg, g_memdup (data, size), size);
637 * gst_rtsp_message_take_body:
638 * @msg: a #GstRTSPMessage
640 * @size: the size of @data
642 * Set the body of @msg to @data and @size. This method takes ownership of
645 * Returns: #GST_RTSP_OK.
648 gst_rtsp_message_take_body (GstRTSPMessage * msg, guint8 * data, guint size)
650 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
651 g_return_val_if_fail (data != NULL || size == 0, GST_RTSP_EINVAL);
657 msg->body_size = size;
663 * gst_rtsp_message_get_body:
664 * @msg: a #GstRTSPMessage
665 * @data: location for the data
666 * @size: location for the size of @data
668 * Get the body of @msg. @data remains valid for as long as @msg is valid and
671 * Returns: #GST_RTSP_OK.
674 gst_rtsp_message_get_body (const GstRTSPMessage * msg, guint8 ** data,
677 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
678 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
679 g_return_val_if_fail (size != NULL, GST_RTSP_EINVAL);
682 *size = msg->body_size;
688 * gst_rtsp_message_steal_body:
689 * @msg: a #GstRTSPMessage
690 * @data: location for the data
691 * @size: location for the size of @data
693 * Take the body of @msg and store it in @data and @size. After this method,
694 * the body and size of @msg will be set to #NULL and 0 respectively.
696 * Returns: #GST_RTSP_OK.
699 gst_rtsp_message_steal_body (GstRTSPMessage * msg, guint8 ** data, guint * size)
701 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
702 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
703 g_return_val_if_fail (size != NULL, GST_RTSP_EINVAL);
706 *size = msg->body_size;
715 dump_mem (guint8 * mem, guint size)
718 GString *string = g_string_sized_new (50);
719 GString *chars = g_string_sized_new (18);
723 if (g_ascii_isprint (mem[i]))
724 g_string_append_printf (chars, "%c", mem[i]);
726 g_string_append_printf (chars, ".");
728 g_string_append_printf (string, "%02x ", mem[i]);
733 if (j == 16 || i == size) {
734 g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
735 string->str, chars->str);
736 g_string_set_size (string, 0);
737 g_string_set_size (chars, 0);
741 g_string_free (string, TRUE);
742 g_string_free (chars, TRUE);
746 dump_key_value (gpointer data, gpointer user_data)
748 RTSPKeyValue *key_value = (RTSPKeyValue *) data;
750 g_print (" key: '%s', value: '%s'\n",
751 gst_rtsp_header_as_text (key_value->field), key_value->value);
755 * gst_rtsp_message_dump:
756 * @msg: a #GstRTSPMessage
758 * Dump the contents of @msg to stdout.
760 * Returns: #GST_RTSP_OK.
763 gst_rtsp_message_dump (GstRTSPMessage * msg)
768 g_return_val_if_fail (msg != NULL, GST_RTSP_EINVAL);
771 case GST_RTSP_MESSAGE_REQUEST:
772 g_print ("RTSP request message %p\n", msg);
773 g_print (" request line:\n");
774 g_print (" method: '%s'\n",
775 gst_rtsp_method_as_text (msg->type_data.request.method));
776 g_print (" uri: '%s'\n", msg->type_data.request.uri);
777 g_print (" version: '%s'\n",
778 gst_rtsp_version_as_text (msg->type_data.request.version));
779 g_print (" headers:\n");
780 key_value_foreach (msg->hdr_fields, dump_key_value, NULL);
781 g_print (" body:\n");
782 gst_rtsp_message_get_body (msg, &data, &size);
783 dump_mem (data, size);
785 case GST_RTSP_MESSAGE_RESPONSE:
786 g_print ("RTSP response message %p\n", msg);
787 g_print (" status line:\n");
788 g_print (" code: '%d'\n", msg->type_data.response.code);
789 g_print (" reason: '%s'\n", msg->type_data.response.reason);
790 g_print (" version: '%s'\n",
791 gst_rtsp_version_as_text (msg->type_data.response.version));
792 g_print (" headers:\n");
793 key_value_foreach (msg->hdr_fields, dump_key_value, NULL);
794 gst_rtsp_message_get_body (msg, &data, &size);
795 g_print (" body: length %d\n", size);
796 dump_mem (data, size);
798 case GST_RTSP_MESSAGE_DATA:
799 g_print ("RTSP data message %p\n", msg);
800 g_print (" channel: '%d'\n", msg->type_data.data.channel);
801 g_print (" size: '%d'\n", msg->body_size);
802 gst_rtsp_message_get_body (msg, &data, &size);
803 dump_mem (data, size);
806 g_print ("unsupported message type %d\n", msg->type);
807 return GST_RTSP_EINVAL;