comparison ac3_parser.h @ 12165:4f06422196ee libavcodec

Restore mistakenly removed [in]/[out] Doxygen parameter attributes.
author diego
date Wed, 14 Jul 2010 21:22:06 +0000
parents 372f7fed2806
children
comparison
equal deleted inserted replaced
12164:59ba77fe9922 12165:4f06422196ee
28 28
29 /** 29 /**
30 * Parse AC-3 frame header. 30 * Parse AC-3 frame header.
31 * Parse the header up to the lfeon element, which is the first 52 or 54 bits 31 * Parse the header up to the lfeon element, which is the first 52 or 54 bits
32 * depending on the audio coding mode. 32 * depending on the audio coding mode.
33 * @param gbc BitContext containing the first 54 bits of the frame. 33 * @param[in] gbc BitContext containing the first 54 bits of the frame.
34 * @param hdr Pointer to struct where header info is written. 34 * @param[out] hdr Pointer to struct where header info is written.
35 * @return Returns 0 on success, -1 if there is a sync word mismatch, 35 * @return Returns 0 on success, -1 if there is a sync word mismatch,
36 * -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate) 36 * -2 if the bsid (version) element is invalid, -3 if the fscod (sample rate)
37 * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid. 37 * element is invalid, or -4 if the frmsizecod (bit rate) element is invalid.
38 */ 38 */
39 int ff_ac3_parse_header(GetBitContext *gbc, AC3HeaderInfo *hdr); 39 int ff_ac3_parse_header(GetBitContext *gbc, AC3HeaderInfo *hdr);
41 /** 41 /**
42 * Parse AC-3 frame header and sets channel_map 42 * Parse AC-3 frame header and sets channel_map
43 * Parse the header up to the lfeon (channel_map in E-AC-3) 43 * Parse the header up to the lfeon (channel_map in E-AC-3)
44 * element, which is the first 52, 54 or 104 bits depending 44 * element, which is the first 52, 54 or 104 bits depending
45 * on the audio coding mode. 45 * on the audio coding mode.
46 * @param gbc BitContext containing the first 54 bits of the frame. 46 * @param[in] gbc BitContext containing the first 54 bits of the frame.
47 * @param hdr Pointer to struct where header info is written. 47 * @param[out] hdr Pointer to struct where header info is written.
48 * @return value returned by ff_ac3_parse_header 48 * @return value returned by ff_ac3_parse_header
49 */ 49 */
50 int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr); 50 int ff_ac3_parse_header_full(GetBitContext *gbc, AC3HeaderInfo *hdr);
51 51
52 #endif /* AVCODEC_AC3_PARSER_H */ 52 #endif /* AVCODEC_AC3_PARSER_H */