[2/5] videodev.h: add PIX_FMT_FWHT for use with vicodec

Message ID d912d4c6-90ec-ed89-31fa-6a5243a7b0de@cisco.com (mailing list archive)
State Superseded, archived
Delegated to: Hans Verkuil
Headers

Commit Message

Hans Verkuil (hansverk) July 19, 2018, 1:20 p.m. UTC
  On 07/19/18 15:15, sakari.ailus@iki.fi wrote:
> On Thu, Jul 19, 2018 at 02:13:50PM +0200, Hans Verkuil wrote:
>> From: Hans Verkuil <hansverk@cisco.com>
>>
>> Add a new pixelformat for the vicodec software codec using the
>> Fast Walsh Hadamard Transform.
>>
>> Signed-off-by: Hans Verkuil <hansverk@cisco.com>
> 
> Could you add documentation for this format, please?
> 

??? It's part of the patch:


Since the whole codec is implemented in the vicodec source I didn't think it
necessary to say more about it.

Regards,

	Hans
  

Comments

Sakari Ailus July 19, 2018, 3:39 p.m. UTC | #1
On Thu, Jul 19, 2018 at 03:20:22PM +0200, Hans Verkuil wrote:
> On 07/19/18 15:15, sakari.ailus@iki.fi wrote:
> > On Thu, Jul 19, 2018 at 02:13:50PM +0200, Hans Verkuil wrote:
> >> From: Hans Verkuil <hansverk@cisco.com>
> >>
> >> Add a new pixelformat for the vicodec software codec using the
> >> Fast Walsh Hadamard Transform.
> >>
> >> Signed-off-by: Hans Verkuil <hansverk@cisco.com>
> > 
> > Could you add documentation for this format, please?
> > 
> 
> ??? It's part of the patch:
> 
> diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> index abec03937bb3..e5419f046b59 100644
> --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> +++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
> @@ -95,3 +95,10 @@ Compressed Formats
>        - ``V4L2_PIX_FMT_HEVC``
>        - 'HEVC'
>        - HEVC/H.265 video elementary stream.
> +    * .. _V4L2-PIX-FMT-FWHT:
> +
> +      - ``V4L2_PIX_FMT_FWHT``
> +      - 'FWHT'
> +      - Video elementary stream using a codec based on the Fast Walsh Hadamard
> +        Transform. This codec is implemented by the vicodec ('Virtual Codec')
> +	driver.
> 
> Since the whole codec is implemented in the vicodec source I didn't think it
> necessary to say more about it.

Oh, well. The source is there but user space developers shouldn't need to
read it. OTOH it might be that they're also not the primary audience for
this driver either. If there's a Wikipedia article you could refer to or
such that'd be fine IMO, too.

Up to you.
  
Hans Verkuil July 19, 2018, 3:52 p.m. UTC | #2
On 07/19/2018 05:39 PM, Sakari Ailus wrote:
> On Thu, Jul 19, 2018 at 03:20:22PM +0200, Hans Verkuil wrote:
>> On 07/19/18 15:15, sakari.ailus@iki.fi wrote:
>>> On Thu, Jul 19, 2018 at 02:13:50PM +0200, Hans Verkuil wrote:
>>>> From: Hans Verkuil <hansverk@cisco.com>
>>>>
>>>> Add a new pixelformat for the vicodec software codec using the
>>>> Fast Walsh Hadamard Transform.
>>>>
>>>> Signed-off-by: Hans Verkuil <hansverk@cisco.com>
>>>
>>> Could you add documentation for this format, please?
>>>
>>
>> ??? It's part of the patch:
>>
>> diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>> index abec03937bb3..e5419f046b59 100644
>> --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>> +++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>> @@ -95,3 +95,10 @@ Compressed Formats
>>        - ``V4L2_PIX_FMT_HEVC``
>>        - 'HEVC'
>>        - HEVC/H.265 video elementary stream.
>> +    * .. _V4L2-PIX-FMT-FWHT:
>> +
>> +      - ``V4L2_PIX_FMT_FWHT``
>> +      - 'FWHT'
>> +      - Video elementary stream using a codec based on the Fast Walsh Hadamard
>> +        Transform. This codec is implemented by the vicodec ('Virtual Codec')
>> +	driver.
>>
>> Since the whole codec is implemented in the vicodec source I didn't think it
>> necessary to say more about it.
> 
> Oh, well. The source is there but user space developers shouldn't need to
> read it. OTOH it might be that they're also not the primary audience for
> this driver either. If there's a Wikipedia article you could refer to or
> such that'd be fine IMO, too.
> 
> Up to you.
> 

Tom,

Do you have a newer version of your document? If not, can I refer to the version
I have? If it can be put up at the linuxtv.org website, then that takes care of
the documentation.

Regards,

	Hans
  
Hans Verkuil July 23, 2018, 7:54 a.m. UTC | #3
On 21/07/18 19:51, Tom aan de Wiel wrote:
> Hi!
> 
> As of now, the version of the document I have locally is pretty much identical to the one you already linked to.
> I haven't had the time to shape it into a more documentation kind of document instead of the report format it has now.
> However, the report does contain all details and therefore could suffice as documentation for the time being?
OK, then I'll ask Mauro to put up the document I have on linuxtv.org so I can refer to it.

Thanks!

	Hans

> 
> Tom
> 
> tor. 19. jul. 2018 kl. 17:52 skrev Hans Verkuil <hverkuil@xs4all.nl <mailto:hverkuil@xs4all.nl>>:
> 
>     On 07/19/2018 05:39 PM, Sakari Ailus wrote:
>     > On Thu, Jul 19, 2018 at 03:20:22PM +0200, Hans Verkuil wrote:
>     >> On 07/19/18 15:15, sakari.ailus@iki.fi <mailto:sakari.ailus@iki.fi> wrote:
>     >>> On Thu, Jul 19, 2018 at 02:13:50PM +0200, Hans Verkuil wrote:
>     >>>> From: Hans Verkuil <hansverk@cisco.com <mailto:hansverk@cisco.com>>
>     >>>>
>     >>>> Add a new pixelformat for the vicodec software codec using the
>     >>>> Fast Walsh Hadamard Transform.
>     >>>>
>     >>>> Signed-off-by: Hans Verkuil <hansverk@cisco.com <mailto:hansverk@cisco.com>>
>     >>>
>     >>> Could you add documentation for this format, please?
>     >>>
>     >>
>     >> ??? It's part of the patch:
>     >>
>     >> diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>     >> index abec03937bb3..e5419f046b59 100644
>     >> --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>     >> +++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
>     >> @@ -95,3 +95,10 @@ Compressed Formats
>     >>        - ``V4L2_PIX_FMT_HEVC``
>     >>        - 'HEVC'
>     >>        - HEVC/H.265 video elementary stream.
>     >> +    * .. _V4L2-PIX-FMT-FWHT:
>     >> +
>     >> +      - ``V4L2_PIX_FMT_FWHT``
>     >> +      - 'FWHT'
>     >> +      - Video elementary stream using a codec based on the Fast Walsh Hadamard
>     >> +        Transform. This codec is implemented by the vicodec ('Virtual Codec')
>     >> +    driver.
>     >>
>     >> Since the whole codec is implemented in the vicodec source I didn't think it
>     >> necessary to say more about it.
>     >
>     > Oh, well. The source is there but user space developers shouldn't need to
>     > read it. OTOH it might be that they're also not the primary audience for
>     > this driver either. If there's a Wikipedia article you could refer to or
>     > such that'd be fine IMO, too.
>     >
>     > Up to you.
>     >
> 
>     Tom,
> 
>     Do you have a newer version of your document? If not, can I refer to the version
>     I have? If it can be put up at the linuxtv.org <http://linuxtv.org> website, then that takes care of
>     the documentation.
> 
>     Regards,
> 
>             Hans
>
  

Patch

diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
index abec03937bb3..e5419f046b59 100644
--- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst
+++ b/Documentation/media/uapi/v4l/pixfmt-compressed.rst
@@ -95,3 +95,10 @@  Compressed Formats
       - ``V4L2_PIX_FMT_HEVC``
       - 'HEVC'
       - HEVC/H.265 video elementary stream.
+    * .. _V4L2-PIX-FMT-FWHT:
+
+      - ``V4L2_PIX_FMT_FWHT``
+      - 'FWHT'
+      - Video elementary stream using a codec based on the Fast Walsh Hadamard
+        Transform. This codec is implemented by the vicodec ('Virtual Codec')
+	driver.