|
|
Log in / Subscribe / Register

Document the V4L2 (stateful) Codec API

From:  Tomasz Figa <tfiga-AT-chromium.org>
To:  linux-media-AT-vger.kernel.org
Subject:  [RFC PATCH 0/2] Document the V4L2 (stateful) Codec API
Date:  Tue, 5 Jun 2018 19:33:26 +0900
Message-ID:  <20180605103328.176255-1-tfiga@chromium.org>
Cc:  linux-kernel-AT-vger.kernel.org, Mauro Carvalho Chehab <mchehab-AT-kernel.org>, Hans Verkuil <hverkuil-AT-xs4all.nl>, =?UTF-8?q?Pawe=C5=82=20O=C5=9Bciak?= <posciak-AT-chromium.org>, Alexandre Courbot <acourbot-AT-chromium.org>, Kamil Debski <kamil-AT-wypas.org>, Andrzej Hajda <a.hajda-AT-samsung.com>, Kyungmin Park <kyungmin.park-AT-samsung.com>, Jeongtae Park <jtp.park-AT-samsung.com>, Philipp Zabel <p.zabel-AT-pengutronix.de>, Tiffany Lin <tiffany.lin-AT-mediatek.com>, Andrew-CT Chen <andrew-ct.chen-AT-mediatek.com>, Stanimir Varbanov <stanimir.varbanov-AT-linaro.org>, Todor Tomov <todor.tomov-AT-linaro.org>, Nicolas Dufresne <nicolas-AT-ndufresne.ca>, Paul Kocialkowski <paul.kocialkowski-AT-bootlin.com>, Laurent Pinchart <laurent.pinchart-AT-ideasonboard.com>, Tomasz Figa <tfiga-AT-chromium.org>
Archive-link:  Article

This series attempts to add the documentation of what was discussed
during Media Workshops at LinuxCon Europe 2012 in Barcelona and then
later Embedded Linux Conference Europe 2014 in Düsseldorf and then
eventually written down by Pawel Osciak and tweaked a bit by Chrome OS
video team (but mostly in a cosmetic way or making the document more
precise), during the several years of Chrome OS using the APIs in
production.

Note that most, if not all, of the API is already implemented in
existing mainline drivers, such as s5p-mfc or mtk-vcodec. Intention of
this series is just to formalize what we already have.

It is an initial conversion from Google Docs to RST, so formatting is
likely to need some further polishing. It is also the first time for me
to create such long RST documention. I could not find any other instance
of similar userspace sequence specifications among our Media documents,
so I mostly followed what was there in the source. Feel free to suggest
a better format.

Much of credits should go to Pawel Osciak, for writing most of the
original text.

Tomasz Figa (2):
  media: docs-rst: Add decoder UAPI specification to Codec Interfaces
  media: docs-rst: Add encoder UAPI specification to Codec Interfaces

 Documentation/media/uapi/v4l/dev-codec.rst | 1084 ++++++++++++++++++++
 Documentation/media/uapi/v4l/v4l2.rst      |   14 +-
 2 files changed, 1097 insertions(+), 1 deletion(-)

-- 
2.17.1.1185.g55be947832-goog



Copyright © 2018, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds