diff mbox

[v3,03/22,media] Docbook: media-types.xml: Add Audio Function Entities

Message ID f591af59b7b1c77b5a17603a1a677a32b8e19132.1455233153.git.shuahkh@osg.samsung.com (mailing list archive)
State New, archived
Headers show

Commit Message

Shuah Khan Feb. 11, 2016, 11:41 p.m. UTC
Add Audio Function Entities

Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
---
 Documentation/DocBook/media/v4l/media-types.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Mauro Carvalho Chehab Feb. 17, 2016, 12:23 p.m. UTC | #1
Em Thu, 11 Feb 2016 16:41:19 -0700
Shuah Khan <shuahkh@osg.samsung.com> escreveu:

> Add Audio Function Entities
> 
> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> ---
>  Documentation/DocBook/media/v4l/media-types.xml | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/Documentation/DocBook/media/v4l/media-types.xml b/Documentation/DocBook/media/v4l/media-types.xml
> index 3730967..924a604 100644
> --- a/Documentation/DocBook/media/v4l/media-types.xml
> +++ b/Documentation/DocBook/media/v4l/media-types.xml
> @@ -113,6 +113,18 @@
>  		   decoder.
>  	    </entry>
>  	  </row>
> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_CAPTURE</constant></entry>
> +	    <entry>Audio Capture Function Entity.</entry>
> +	  </row>
> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_PLAYBACK</constant></entry>
> +	    <entry>Audio Playback Function Entity.</entry>
> +	  </row>
> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_MIXER</constant></entry>
> +	    <entry>Audio Mixer Function Entity.</entry>
> +	  </row>
>  	</tbody>
>        </tgroup>
>      </table>

Looks OK to me.

Takashi,

Could you ack if ok for you?
Takashi Iwai Feb. 26, 2016, 7:40 p.m. UTC | #2
On Wed, 17 Feb 2016 13:23:09 +0100,
Mauro Carvalho Chehab wrote:
> 
> Em Thu, 11 Feb 2016 16:41:19 -0700
> Shuah Khan <shuahkh@osg.samsung.com> escreveu:
> 
> > Add Audio Function Entities
> > 
> > Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> > ---
> >  Documentation/DocBook/media/v4l/media-types.xml | 12 ++++++++++++
> >  1 file changed, 12 insertions(+)
> > 
> > diff --git a/Documentation/DocBook/media/v4l/media-types.xml b/Documentation/DocBook/media/v4l/media-types.xml
> > index 3730967..924a604 100644
> > --- a/Documentation/DocBook/media/v4l/media-types.xml
> > +++ b/Documentation/DocBook/media/v4l/media-types.xml
> > @@ -113,6 +113,18 @@
> >  		   decoder.
> >  	    </entry>
> >  	  </row>
> > +	  <row>
> > +	    <entry><constant>MEDIA_ENT_F_AUDIO_CAPTURE</constant></entry>
> > +	    <entry>Audio Capture Function Entity.</entry>
> > +	  </row>
> > +	  <row>
> > +	    <entry><constant>MEDIA_ENT_F_AUDIO_PLAYBACK</constant></entry>
> > +	    <entry>Audio Playback Function Entity.</entry>
> > +	  </row>
> > +	  <row>
> > +	    <entry><constant>MEDIA_ENT_F_AUDIO_MIXER</constant></entry>
> > +	    <entry>Audio Mixer Function Entity.</entry>
> > +	  </row>
> >  	</tbody>
> >        </tgroup>
> >      </table>
> 
> Looks OK to me.
> 
> Takashi,
> 
> Could you ack if ok for you?

Yeah, nothing looks wrong, as it's pretty straightforward :)

Acked-by: Takashi Iwai <tiwai@suse.de>


thanks,

Takashi
Laurent Pinchart Feb. 29, 2016, 2:46 a.m. UTC | #3
Hi Shuah,

Thank you for the patch.

On Thursday 11 February 2016 16:41:19 Shuah Khan wrote:
> Add Audio Function Entities
> 
> Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>
> ---
>  Documentation/DocBook/media/v4l/media-types.xml | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/Documentation/DocBook/media/v4l/media-types.xml
> b/Documentation/DocBook/media/v4l/media-types.xml index 3730967..924a604
> 100644
> --- a/Documentation/DocBook/media/v4l/media-types.xml
> +++ b/Documentation/DocBook/media/v4l/media-types.xml
> @@ -113,6 +113,18 @@
>  		   decoder.
>  	    </entry>
>  	  </row>
> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_CAPTURE</constant></entry>
> +	    <entry>Audio Capture Function Entity.</entry>
> +	  </row>
> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_PLAYBACK</constant></entry>
> +	    <entry>Audio Playback Function Entity.</entry>
> +	  </row>

I think this deserves a longer description. From the name and short 
description I'm not sure what the capture and playback functions are.

> +	  <row>
> +	    <entry><constant>MEDIA_ENT_F_AUDIO_MIXER</constant></entry>
> +	    <entry>Audio Mixer Function Entity.</entry>
> +	  </row>

Entities can implement multiple functions, so function descriptions shouldn't 
refer to entity this way. MEDIA_ENT_F_AUDIO_MIXER doesn't mean that the entity 
is an audio mixer, it means that the entity implements the audio mixer 
function. If you want to keep the description short you could just write 
"Audio mixer". A longer description could be "The entity can mix multiple 
input audio streams to produce an output audio stream.".

>  	</tbody>
>        </tgroup>
>      </table>
diff mbox

Patch

diff --git a/Documentation/DocBook/media/v4l/media-types.xml b/Documentation/DocBook/media/v4l/media-types.xml
index 3730967..924a604 100644
--- a/Documentation/DocBook/media/v4l/media-types.xml
+++ b/Documentation/DocBook/media/v4l/media-types.xml
@@ -113,6 +113,18 @@ 
 		   decoder.
 	    </entry>
 	  </row>
+	  <row>
+	    <entry><constant>MEDIA_ENT_F_AUDIO_CAPTURE</constant></entry>
+	    <entry>Audio Capture Function Entity.</entry>
+	  </row>
+	  <row>
+	    <entry><constant>MEDIA_ENT_F_AUDIO_PLAYBACK</constant></entry>
+	    <entry>Audio Playback Function Entity.</entry>
+	  </row>
+	  <row>
+	    <entry><constant>MEDIA_ENT_F_AUDIO_MIXER</constant></entry>
+	    <entry>Audio Mixer Function Entity.</entry>
+	  </row>
 	</tbody>
       </tgroup>
     </table>