Lines Matching full:doc

16 #[doc = " Resampler object handle."]
18 #[doc = "< 16-bit precision resampler."]
19 #[doc = "<"]
21 #[doc = "< 16-bit precision resampler for impulse responses."]
22 #[doc = "<"]
24 #[doc = "< 24-bit precision resampler (including 32-bit floating"]
25 #[doc = "< point)."]
26 #[doc = "<"]
28 #[doc = " Possible resampler object resolutions."]
31     #[doc = " Function creates a new linear-phase resampler object."]
32     #[doc = ""]
33     #[doc = " @param SrcSampleRate Source signal sample rate. Both sample rates can"]
34     #[doc = " be specified as a ratio, e.g. SrcSampleRate = 1.0, DstSampleRate = 2.0."]
35     #[doc = " @param DstSampleRate Destination signal sample rate."]
36     #[doc = " @param MaxInLen The maximal planned length of the input buffer (in samples)"]
37     #[doc = " that will be passed to the resampler. The resampler relies on this value as"]
38     #[doc = " it allocates intermediate buffers. Input buffers longer than this value"]
39     #[doc = " should never be supplied to the resampler. Note that the resampler may use"]
40     #[doc = " the input buffer itself for intermediate sample data storage."]
41     #[doc = " @param Res Resampler's required resolution."]
51     #[doc = " Function deletes a resampler previously created via the r8b_create()"]
52     #[doc = " function."]
53     #[doc = ""]
54     #[doc = " @param rs Resampler object to delete."]
58     #[doc = " Function clears (resets) the state of the resampler object and returns it"]
59     #[doc = " to the state after construction. All input data accumulated in the"]
60     #[doc = " internal buffer of this resampler object so far will be discarded."]
61     #[doc = ""]
62     #[doc = " @param rs Resampler object to clear."]
66     #[doc = " Function performs sample rate conversion."]
67     #[doc = ""]
68     #[doc = " If the source and destination sample rates are equal, the resampler will do"]
69     #[doc = " nothing and will simply return the input buffer unchanged."]
70     #[doc = ""]
71     #[doc = " You do not need to allocate an intermediate output buffer for use with this"]
72     #[doc = " function. If required, the resampler will allocate a suitable intermediate"]
73     #[doc = " output buffer itself."]
74     #[doc = ""]
75     #[doc = " @param rs Resampler object that performs processing."]
76     #[doc = " @param ip0 Input buffer. This buffer may be used as output buffer by this"]
77     #[doc = " function."]
78     #[doc = " @param l The number of samples available in the input buffer."]
79     #[doc = " @param[out] op0 This variable receives the pointer to the resampled data."]
80     #[doc = " This pointer may point to the address within the \"ip0\" input buffer, or to"]
81     #[doc = " *this object's internal buffer. In real-time applications it is suggested"]
82     #[doc = " to pass this pointer to the next output audio block and consume any data"]
83     #[doc = " left from the previous output audio block first before calling the"]
84     #[doc = " r8b_process() function again. The buffer pointed to by the \"op0\" on return"]
85     #[doc = " may be owned by the resampler, so it should not be freed by the caller."]
86     #[doc = " @return The number of samples available in the \"op0\" output buffer. If the"]
87     #[doc = " data from the output buffer \"op0\" is going to be written to a bigger output"]
88     #[doc = " buffer, it is suggested to check the returned number of samples so that no"]
89     #[doc = " overflow of the bigger output buffer happens."]