Deprecate av_parse_video_frame_size() and av_parse_video_frame_rate()
[libav.git] / libavcore / parseutils.h
CommitLineData
126b638e
SS
1/*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg 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 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19#ifndef AVCORE_PARSEUTILS_H
20#define AVCORE_PARSEUTILS_H
21
22#include <libavutil/rational.h>
23
24/**
25 * @file
26 * misc parsing utilities for libavcore
27 */
28
29/**
30 * Parse str and put in width_ptr and height_ptr the detected values.
31 *
32 * @param[in,out] width_ptr pointer to the variable which will contain the detected
33 * frame width value
34 * @param[in,out] height_ptr pointer to the variable which will contain the detected
35 * frame height value
36 * @param[in] str the string to parse: it has to be a string in the format
37 * width x height or a valid video frame size abbreviation.
38 * @return >= 0 on success, a negative error code otherwise
39 */
40int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str);
41
42/**
43 * Parse str and store the detected values in *frame_rate.
44 *
45 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
46 * frame rate
47 * @param[in] str the string to parse: it has to be a string in the format
48 * frame_rate_num / frame_rate_den, a float number or a valid video rate abbreviation
49 * @return >= 0 on success, a negative error code otherwise
50 */
51int av_parse_video_rate(AVRational *frame_rate, const char *str);
52
53#endif /* AVCORE_PARSEUTILS_H */