Split ff_log_missing_feature into ff_log_missing_feature
[ffmpeg.git] / libavcodec / internal.h
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 /**
20  * @file internal.h
21  * common internal api header.
22  */
23
24 #ifndef AVCODEC_INTERNAL_H
25 #define AVCODEC_INTERNAL_H
26
27 /**
28  * Logs a generic warning message about a missing feature.
29  * @param[in] avc a pointer to an arbitrary struct of which the first field is
30  * a pointer to an AVClass struct
31  * @param[in] feature string containing the name of the missing feature
32  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
33  * If \p want_sample is non-zero, additional verbage will be added to the log
34  * message which tells the user how to report samples to the development
35  * mailing list.
36  */
37 void ff_log_missing_feature(void *avc, const char *feature, int want_sample);
38
39 /**
40  * Logs a generic warning message asking for a sample.
41  * @param[in] avc a pointer to an arbitrary struct of which the first field is
42  * a pointer to an AVClass struct
43  * @param[in] msg string containing an optional message, or NULL if no message
44  */
45 void ff_log_ask_for_sample(void *avc, const char *msg);
46
47 #endif /* AVCODEC_INTERNAL_H */