public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@redhat.com>
To: unlisted-recipients:; (no To-header on input)@casper.infradead.org
Cc: Linux Media Mailing List <linux-media@vger.kernel.org>
Subject: [PATCH 13/13] [media] DocBook/video.xml: Document the remaining data structures
Date: Wed, 8 Jun 2011 17:23:10 -0300	[thread overview]
Message-ID: <20110608172310.6d91b712@pedra> (raw)
In-Reply-To: <cover.1307563765.git.mchehab@redhat.com>

Now, all data structures are commented. A few ioctls remain undocumented:

Error: no ID for constraint linkend: VIDEO_GET_SIZE.
Error: no ID for constraint linkend: VIDEO_GET_FRAME_RATE.
Error: no ID for constraint linkend: VIDEO_GET_PTS.
Error: no ID for constraint linkend: VIDEO_GET_FRAME_COUNT.
Error: no ID for constraint linkend: VIDEO_COMMAND.
Error: no ID for constraint linkend: VIDEO_TRY_COMMAND.

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

diff --git a/Documentation/DocBook/media/dvb/video.xml b/Documentation/DocBook/media/dvb/video.xml
index ef30f69..539c79b 100644
--- a/Documentation/DocBook/media/dvb/video.xml
+++ b/Documentation/DocBook/media/dvb/video.xml
@@ -37,8 +37,8 @@ stream.
 </para>
 </section>
 
-<section id="video-display-format-t">
-<title>video_display_format_t</title>
+<section id="video-displayformat-t">
+<title>video_displayformat_t</title>
 <para>In case the display format of the video stream and of the display hardware differ the
 application has to specify how to handle the cropping of the picture. This can be done using
 the VIDEO_SET_DISPLAY_FORMAT call (??) which accepts
@@ -89,6 +89,49 @@ typedef enum {
 </programlisting>
 </section>
 
+<section id="video-command">
+<para>The structure must be zeroed before use by the application
+This ensures it can be extended safely in the future.</para>
+<title>struct video-command</title>
+<programlisting>
+struct video_command {
+	__u32 cmd;
+	__u32 flags;
+	union {
+		struct {
+			__u64 pts;
+		} stop;
+
+		struct {
+			/&#x22C6; 0 or 1000 specifies normal speed,
+			   1 specifies forward single stepping,
+			   -1 specifies backward single stepping,
+			   &gt;>1: playback at speed/1000 of the normal speed,
+			   &lt;-1: reverse playback at (-speed/1000) of the normal speed. &#x22C6;/
+			__s32 speed;
+			__u32 format;
+		} play;
+
+		struct {
+			__u32 data[16];
+		} raw;
+	};
+};
+</programlisting>
+</section>
+
+<section id="video-size-t">
+<title>struct video_size-t</title>
+<programlisting>
+typedef struct {
+	int w;
+	int h;
+	video_format_t aspect_ratio;
+} video_size_t;
+</programlisting>
+</section>
+
+
 <section id="video-event">
 <title>struct video_event</title>
 <para>The following is the structure of a video event as it is returned by the VIDEO_GET_EVENT
-- 
1.7.1


      parent reply	other threads:[~2011-06-08 20:25 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1307563765.git.mchehab@redhat.com>
2011-06-08 20:22 ` [PATCH 01/13] [media] DocBook: Add the other DVB API header files Mauro Carvalho Chehab
2011-06-08 20:22 ` [PATCH 02/13] [media] DocBook/audio.xml: match section ID's with the reference links Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 03/13] [media] DocBook/audio.xml: synchronize attribute changes Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 04/13] [media] DocBook: Document AUDIO_CONTINUE ioctl Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 05/13] [media] dvb/audio.h: Remove definition for AUDIO_GET_PTS Mauro Carvalho Chehab
2011-06-09 12:44   ` Andreas Oberritter
2011-06-09 13:04     ` Mauro Carvalho Chehab
2011-06-09 13:07       ` Andreas Oberritter
2011-06-10 13:18         ` Devin Heitmueller
2011-06-10 13:38           ` [linux-media] " Klaus Schmidinger
2011-06-08 20:23 ` [PATCH 06/13] [media] Docbook/ca.xml: match section ID's with the reference links Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 07/13] [media] DocBook/ca.xml: Describe structure ca_pid Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 08/13] [media] DocBook/demux.xml: Fix section references with dmx.h.xml Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 09/13] [media] DocBook/demux.xml: Add the remaining data structures to the API spec Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 10/13] [media] DocBook/net.xml: Synchronize Network data structure Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 11/13] [media] DocBook/Makefile: Remove osd.h header Mauro Carvalho Chehab
2011-06-08 20:23 ` [PATCH 12/13] [media] DocBook/video.xml: Fix section references with video.h.xml Mauro Carvalho Chehab
2011-06-08 20:23 ` Mauro Carvalho Chehab [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20110608172310.6d91b712@pedra \
    --to=mchehab@redhat.com \
    --cc=linux-media@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox