[FFmpeg-devel] [PATCH 07/10] swr: start doxycommenting the API.
ubitux at gmail.com
Thu Nov 17 10:22:02 CET 2011
On Thu, Nov 17, 2011 at 02:59:35AM +0100, Michael Niedermayer wrote:
> > + void *log_ctx; ///< logging context
> parent loging context
> > + enum AVSampleFormat in_sample_fmt; ///< input sample format
> > + enum AVSampleFormat int_sample_fmt; ///< internal sample format (AV_SAMPLE_FMT_FLT or AV_SAMPLE_FMT_S16)
> > + enum AVSampleFormat out_sample_fmt; ///< output sample format
> > + int64_t in_ch_layout; ///< input channel layout
> > + int64_t out_ch_layout; ///< output channel layout
> > + int in_sample_rate; ///< input sample rate
> > + int out_sample_rate; ///< output sample rate
> > + int flags; ///< miscellaneous flags such as SWR_FLAG_RESAMPLE
> > + float slev; ///< surround mixing level, XXX: unused
> > + float clev; ///< center mixing level
> > + float rematrix_volume; ///< used to set a different rematrixing volume than 1.0
> rematrixing sometimes has to reduce the volume to avoid overflow so 1.0 is not always teh default
OK, changed to "rematrix volume coefficient"
> > + const int *channel_map; ///< channel index (or -1 if muted channel) map
> > + int used_ch_count; ///< number of used channels (mapped channel count if channel_map, otherwise in.ch_count)
> number of used input channels
Indeed, added the "input".
> > + float matrix [SWR_CH_MAX][SWR_CH_MAX ]; ///< float channel levels squared matrix for rematrixing
> > + int32_t matrix32 [SWR_CH_MAX][SWR_CH_MAX ]; ///< integer channel levels squared matrix for rematrixing
> > + uint8_t matrix_ch[SWR_CH_MAX][SWR_CH_MAX+1]; ///< channel matrix for rematrixing
> these sound non ideal, i suggest to leave it to a later patch
OK, feel free to add something that makes sense to you then, I'm curious
> the rest sounded ok to me
Great! I also removed the "/* private fields */" comment (previously
"//below are private") because it doesn't really make sense: the struct is
opaque so all the fields are actually private.
I just pused the whole patch, thanks for the review.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 490 bytes
Desc: not available
More information about the ffmpeg-devel