1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28/** \file
29 * Support for setting/getting parameters as string values.
30 */
31
32#ifndef MMAL_PARAM_CONVERT_H
33#define MMAL_PARAM_CONVERT_H
34
35#include "interface/mmal/mmal.h"
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/** Parse a video size. e.g. "1080p" gives 1920x1080.
42 *
43 * @param w width result
44 * @param h height result
45 * @param str string to convert
46 * @return MMAL_SUCCESS or error code
47 */
48MMAL_STATUS_T mmal_parse_video_size(uint32_t *w, uint32_t *h, const char *str);
49
50/** Parse a rational number. e.g. "30000/1001", "30", etc.
51 * @param dest filled in with result
52 * @param str string to convert
53 * @return MMAL_SUCCESS or error code
54 */
55MMAL_STATUS_T mmal_parse_rational(MMAL_RATIONAL_T *dest, const char *str);
56
57/** Parse an integer, e.g. -10, 0x1A, etc.
58 * @param dest filled in with result
59 * @param str string to convert
60 * @return MMAL_SUCCESS or error code
61 */
62MMAL_STATUS_T mmal_parse_int(int *dest, const char *str);
63
64/** Parse an unsigned integer, e.g. 10, 0x1A, etc.
65 * @param dest filled in with result
66 * @param str string to convert
67 * @return MMAL_SUCCESS or error code
68 */
69MMAL_STATUS_T mmal_parse_uint(unsigned int *dest, const char *str);
70
71/** Parse a geometry for a rectangle
72 *
73 * e.g. 100*100+50+75
74 * or 200*150
75 * @param dest filled in with result
76 * @param str string to convert
77 * @return MMAL_SUCCESS or error code
78 */
79MMAL_STATUS_T mmal_parse_geometry(MMAL_RECT_T *dest, const char *str);
80
81/** Parse a video codec name (something that can be encoded/decoded)
82 * @param str string to convert
83 * @param dest filled in with result
84 * @return MMAL_SUCCESS or error code
85 */
86MMAL_STATUS_T mmal_parse_video_codec(uint32_t *dest, const char *str);
87
88#ifdef __cplusplus
89}
90#endif
91
92#endif
93