[media] DocBook media: document codec draining flow
authorPhilipp Zabel <p.zabel@pengutronix.de>
Mon, 4 May 2015 10:51:04 +0000 (07:51 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 12 May 2015 06:50:53 +0000 (03:50 -0300)
commit8cee396bfa77ce3a2e5fe48f597206c1cd547f9c
tree04676c7cb74ea8d58b4c4f1d43af192a166080dc
parent6425f646ffb1da577501098331da38df91d6aa6d
[media] DocBook media: document codec draining flow

Document the interaction between VIDIOC_DECODER_CMD V4L2_DEC_CMD_STOP and
VIDIOC_ENCODER_CMD V4L2_ENC_CMD_STOP to start the draining, the V4L2_EVENT_EOS
event signalling all capture buffers are finished and ready to be dequeud,
the new V4L2_BUF_FLAG_LAST buffer flag indicating the last buffer being dequeued
from the capture queue, and the poll and VIDIOC_DQBUF ioctl return values once
the queue is drained.

Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Kamil Debski <k.debski@samsung.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/v4l/io.xml
Documentation/DocBook/media/v4l/vidioc-decoder-cmd.xml
Documentation/DocBook/media/v4l/vidioc-encoder-cmd.xml
Documentation/DocBook/media/v4l/vidioc-qbuf.xml