annotate internal.h @ 9772:2771fff83016 libavcodec

100l, the compression field in lcl extradata must be interpreted as int8_t, not uint8_t to allow -1 for "no compression". The original code worked, but only when char was signed.
author reimar
date Sun, 31 May 2009 10:50:54 +0000
parents 2e0b55e4474f
children 2887f410011f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8281
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
1 /*
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
2 * This file is part of FFmpeg.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
3 *
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
4 * FFmpeg is free software; you can redistribute it and/or
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
5 * modify it under the terms of the GNU Lesser General Public
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
6 * License as published by the Free Software Foundation; either
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
7 * version 2.1 of the License, or (at your option) any later version.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
8 *
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
9 * FFmpeg is distributed in the hope that it will be useful,
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
12 * Lesser General Public License for more details.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
13 *
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
14 * You should have received a copy of the GNU Lesser General Public
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
15 * License along with FFmpeg; if not, write to the Free Software
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
17 */
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
18
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
19 /**
8718
e9d9d946f213 Use full internal pathname in doxygen @file directives.
diego
parents: 8603
diff changeset
20 * @file libavcodec/internal.h
8281
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
21 * common internal api header.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
22 */
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
23
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
24 #ifndef AVCODEC_INTERNAL_H
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
25 #define AVCODEC_INTERNAL_H
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
26
9033
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
27 #include <stdint.h>
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
28 #include "avcodec.h"
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
29
8281
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
30 /**
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
31 * Logs a generic warning message about a missing feature.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
32 * @param[in] avc a pointer to an arbitrary struct of which the first field is
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
33 * a pointer to an AVClass struct
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
34 * @param[in] feature string containing the name of the missing feature
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
35 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
36 * If \p want_sample is non-zero, additional verbage will be added to the log
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
37 * message which tells the user how to report samples to the development
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
38 * mailing list.
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
39 */
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
40 void ff_log_missing_feature(void *avc, const char *feature, int want_sample);
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
41
8603
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
42 /**
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
43 * Logs a generic warning message asking for a sample.
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
44 * @param[in] avc a pointer to an arbitrary struct of which the first field is
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
45 * a pointer to an AVClass struct
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
46 * @param[in] msg string containing an optional message, or NULL if no message
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
47 */
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
48 void ff_log_ask_for_sample(void *avc, const char *msg);
555c2ab21d84 Split ff_log_missing_feature into ff_log_missing_feature
benoit
parents: 8281
diff changeset
49
9033
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
50 /**
9046
2e0b55e4474f Add missing prototype for ff_is_hwaccel_pix_fmt().
diego
parents: 9033
diff changeset
51 * Determines whether \p pix_fmt is a hardware accelerated format.
2e0b55e4474f Add missing prototype for ff_is_hwaccel_pix_fmt().
diego
parents: 9033
diff changeset
52 */
2e0b55e4474f Add missing prototype for ff_is_hwaccel_pix_fmt().
diego
parents: 9033
diff changeset
53 int ff_is_hwaccel_pix_fmt(enum PixelFormat pix_fmt);
2e0b55e4474f Add missing prototype for ff_is_hwaccel_pix_fmt().
diego
parents: 9033
diff changeset
54
2e0b55e4474f Add missing prototype for ff_is_hwaccel_pix_fmt().
diego
parents: 9033
diff changeset
55 /**
9033
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
56 * Returns the hardware accelerated codec for codec \p codec_id and
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
57 * pixel format \p pix_fmt.
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
58 *
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
59 * @param codec_id the codec to match
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
60 * @param pix_fmt the pixel format to match
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
61 * @return the hardware accelerated codec, or NULL if none was found.
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
62 */
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
63 AVHWAccel *ff_find_hwaccel(enum CodecID codec_id, enum PixelFormat pix_fmt);
bcf716c58be4 add ff_find_hwaccel() by Gwenole Beauchesne
michael
parents: 8718
diff changeset
64
8281
f93efc084e41 Make av_log_missing_feature an internal function, and change its name
stefano
parents:
diff changeset
65 #endif /* AVCODEC_INTERNAL_H */