[FFmpeg-devel] [PATCH] Cosmetics: improve long names for ffm muxer and demuxer

[Baptiste Coudurier]

Hi,

Stefano Sabatini wrote:
> On date Tuesday 2008-07-22 00:24:22 +0200, Stefano Sabatini encoded:
>> On date Monday 2008-07-21 11:29:53 -0700, Baptiste Coudurier encoded:
>>> Stefano Sabatini wrote:
>>>> On date Sunday 2008-07-20 23:06:26 +0200, Diego Biurrun encoded:
>>>>> On Sun, Jul 20, 2008 at 01:58:57PM -0700, Baptiste Coudurier wrote:
>>>>>> Diego Biurrun wrote:
>>>>>>> On Sun, Jul 20, 2008 at 11:53:09AM -0700, Baptiste Coudurier wrote:
>>>>>>>> Diego Biurrun wrote:
>>>>>>>>> On Sat, Jul 19, 2008 at 06:03:30PM -0700, Baptiste Coudurier wrote:
>>>>>>>>>> Stefano Sabatini wrote:
>>>>>>>>>>> --- libavformat/ffmdec.c	(revision 14284)
>>>>>>>>>>> +++ libavformat/ffmdec.c	(working copy)
>>>>>>>>>>> @@ -477,7 +477,7 @@
>>>>>>>>>>>  
>>>>>>>>>>>  AVInputFormat ffm_demuxer = {
>>>>>>>>>>>      "ffm",
>>>>>>>>>>> -    NULL_IF_CONFIG_SMALL("ffm format"),
>>>>>>>>>>> +    NULL_IF_CONFIG_SMALL("FFserver live feed Muxer"),
>>>>>>>>>>>      sizeof(FFMContext),
>>>>>>>>>> I don't think this is the right name.
>>>>>>>>> Well, it is called by that name in the code:
>>>>>>>>>
>>>>>>>>>  * FFM (ffserver live feed) demuxer
>>>>>>>> Do we add "Muxer" to names ? No, at least not in mxf.c and mov.c
>>>>>>> No, we do not.
>>>>>> So why would you accept this name ? 
>>>> I was trying to explicit the meaning of the FFM acronym (and also to
>>>> make evident the connection with FFserver), I think a better choice
>>>> could be then:
>>>>
>>>> "FFM (FFserver live feed Muxer) format"
>>> I don't think M does stand for "Muxer", so this is a bad name.
>> Well, I read that in the documentation, if you can provide a better
>> bacronym or even the original acronym for it please do it. 
>>
>>>> Long names as we apparently use them in FFmpeg are always supposed to
>>>> be a description of the format (media bitstream or multimedia
>>>> bitstream) rather than of the corresponding encoder/decoder (stream
>>>> codec or muxer/demuxer), in order to get that we have to suffix with
>>>> the type of encoder/decoder (encoder, decoder, muxer, demuxer), which
>>>> in this case would result as: "FFM (FFserver live feed Muxer) format
>>>> {muxer|demuxer}"
>>>>
>>> I don't think this is what is what we should use. Long name is a long
>>> name for the _format_.
>> And indeed I tried (badly?) to explain that, "FFM (FFserver live feed
>> Muxer) format" is indeed a description of a format, and I'm not sure
>> this is the best solution, maybe we should have some structure
>> representing a format (multimedia streams container formats and stream
>> formats), and having the various codecs and muxdem(uxer)s refer them.
> 
> Ping? I want this patch for a personal idiosyncrasy for which I tend
> to get bothered by acronyms, especially when they can't be resolved
> into something intelligible.
> 

If you remove "Muxer", I think Im ok with: "FFM (FFserver live feed) format"

-- 
Baptiste COUDURIER                              GnuPG Key Id: 0x5C1ABAAA
Smartjog USA Inc.                                http://www.smartjog.com
Key fingerprint                 8D77134D20CC9220201FC5DB0AC9325C5C1ABAAA