comparison ac3_parser.h @ 12024:fdafbcef52f5 libavcodec

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 0dce4fe6e6f3
children 372f7fed2806
comparison
equal deleted inserted replaced
12023:c7455450364d 12024:fdafbcef52f5
25 25
26 #include "ac3.h" 26 #include "ac3.h"
27 #include "get_bits.h" 27 #include "get_bits.h"
28 28
29 /** 29 /**
30 * Parses AC-3 frame header. 30 * Parse AC-3 frame header.
31 * Parses 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[in] BitContext containing the first 54 bits of the frame. 33 * @param gbc[in] BitContext containing the first 54 bits of the frame.
34 * @param hdr[out] Pointer to struct where header info is written. 34 * @param hdr[out] 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);
40 40
41 /** 41 /**
42 * Parses AC-3 frame header and sets channel_map 42 * Parse AC-3 frame header and sets channel_map
43 * Parses 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[in] BitContext containing the first 54 bits of the frame. 46 * @param gbc[in] BitContext containing the first 54 bits of the frame.
47 * @param hdr[out] Pointer to struct where header info is written. 47 * @param hdr[out] 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