[FFmpeg-devel] [PATCH] Expand sws_setColorspaceDetails doxygen

[David Conrad]

On Jan 20, 2010, at 8:34 AM, Michael Niedermayer wrote:

> On Wed, Jan 20, 2010 at 06:26:15AM -0500, David Conrad wrote:
>> Hi,
>> 
>> I guess table was supposed to be the coefficients for RGB->YUV conversion, but it's not used for anything.
>> 
> 
>> commit 8fc2063d5cc81b2c867d7179a9f2fc005311f8eb
>> Author: David Conrad <lessen42 at gmail.com>
>> Date:   Wed Jan 20 05:17:35 2010 -0500
>> 
>>    Expand sws_setColorspaceDetails doxygen
>> 
>> diff --git a/swscale.h b/swscale.h
>> index 9e14262..27f4d0a 100644
>> --- a/swscale.h
>> +++ b/swscale.h
>> @@ -196,8 +196,13 @@ int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
>> #endif
>> 
>> /**
>> - * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
>> - * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
>> + * @param inv_table  the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
>> + * @param srcRange   1 if the luma range is 0..255, 0 if it is 16..235
> 
> whatever you prefer
> 
> 
>> + * @param table      unused
> 
> no, thats not the intended API

Should it be something like

@param table   the rgb2yuv coefficients

Though it's not clear to me how two different sets of coefficients would work here, is it intended for converting e.g. 601 yuv -> 709 yuv? In which case I guess the doxy should be

@param inv_table the yuv2rgb coefficients of the source format, normally ff_yuv2rgb_coeffs[x]
@param table     the rgb2yuv coefficients of the destination format