NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

Documentation: Remove | on the left side of diagrams

Browse source 
There's no need to add a character on the left side of the ascii art
diagrams, provided that we indent them properly. Fix it.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2018-12-14 15:29:02 +02:00
parent 17fab5dfc8
commit d416f42cce
1 changed files with 81 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

162
Documentation/docs.rst
View file

@ -150,45 +150,45 @@ Camera Stack
:: ::
| a c / +-------------+ +-------------+ +-------------+ +-------------+ a c / +-------------+ +-------------+ +-------------+ +-------------+
| p a | | Native | | Framework | | Native | | Android | p a | | Native | | Framework | | Native | | Android |
| p t | | V4L2 | | Application | | libcamera | | Camera | p t | | V4L2 | | Application | | libcamera | | Camera |
| l i | | Application | | (gstreamer) | | Application | | Framework | l i | | Application | | (gstreamer) | | Application | | Framework |
| i o \ +-------------+ +-------------+ +-------------+ +-------------+ i o \ +-------------+ +-------------+ +-------------+ +-------------+
| n ^ ^ ^ ^ n ^ ^ ^ ^
| | | | | | | | |
| l a | | | | l a | | | |
| i d v v | v i d v v | v
| b a / +-------------+ +-------------+ | +-------------+ b a / +-------------+ +-------------+ | +-------------+
| c p | | V4L2 | | Camera | | | Android | c p | | V4L2 | | Camera | | | Android |
| a t | | Compat. | | Framework | | | Camera | a t | | Compat. | | Framework | | | Camera |
| m a | | | | (gstreamer) | | | HAL | m a | | | | (gstreamer) | | | HAL |
| e t \ +-------------+ +-------------+ | +-------------+ e t \ +-------------+ +-------------+ | +-------------+
| r i ^ ^ | ^ r i ^ ^ | ^
| a o | | | | a o | | | |
| n | | | | n | | | |
| / | ,................................................ / | ,................................................
| | | ! : Language : ! | | ! : Language : !
| l f | | ! : Bindings : ! l f | | ! : Bindings : !
| i r | | ! : (optional) : ! i r | | ! : (optional) : !
| b a | | \...............................................' b a | | \...............................................'
| c m | | | | | c m | | | | |
| a e | | | | | a e | | | | |
| m w | v v v v m w | v v v v
| e o | +----------------------------------------------------------------+ e o | +----------------------------------------------------------------+
| r r | | | r r | | |
| a k | | libcamera | a k | | libcamera |
| | | | | | |
| \ +----------------------------------------------------------------+ \ +----------------------------------------------------------------+
| ^ ^ ^ ^ ^ ^
| Userspace | | | Userspace | | |
| ------------------------ | ---------------- | ---------------- | --------------- ------------------------ | ---------------- | ---------------- | ---------------
| Kernel | | | Kernel | | |
| v v v v v v
| +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+
| | Media | <--> | Video | <--> | V4L2 | | Media | <--> | Video | <--> | V4L2 |
| | Device | | Device | | Subdev | | Device | | Device | | Subdev |
| +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+
The camera stack comprises four software layers. From bottom to top: The camera stack comprises four software layers. From bottom to top:
@ -226,48 +226,48 @@ libcamera Architecture
:: ::
| ---------------------------< libcamera Public API >--------------------------- ---------------------------< libcamera Public API >---------------------------
| ^ ^ ^ ^
| | | | |
| v v v v
| +-------------+ +-------------------------------------------------+ +-------------+ +-------------------------------------------------+
| | Camera | | Camera Device | | Camera | | Camera Device |
| | Devices | | +---------------------------------------------+ | | Devices | | +---------------------------------------------+ |
| | Manager | | | Device-Agnostic | | | Manager | | | Device-Agnostic | |
| +-------------+ | | | | +-------------+ | | | |
| ^ | | +------------------------+ | ^ | | +------------------------+ |
| | | | | ~~~~~~~~~~~~~~~~~~~~~ | | | | | ~~~~~~~~~~~~~~~~~~~~~ |
| | | | | { +---------------+ } | | | | | { +---------------+ } |
| | | | | } | ////Image//// | { | | | | | } | ////Image//// | { |
| | | | | <-> | /Processing// | } | | | | | <-> | /Processing// | } |
| | | | | } | /Algorithms// | { | | | | | } | /Algorithms// | { |
| | | | | { +---------------+ } | | | | | { +---------------+ } |
| | | | | ~~~~~~~~~~~~~~~~~~~~~ | | | | | ~~~~~~~~~~~~~~~~~~~~~ |
| | | | | ======================== | | | | | ======================== |
| | | | | +---------------+ | | | | | +---------------+ |
| | | | | | //Pipeline/// | | | | | | | //Pipeline/// | |
| | | | | <-> | ///Handler/// | | | | | | <-> | ///Handler/// | |
| | | | | | ///////////// | | | | | | | ///////////// | |
| | | +--------------------+ +---------------+ | | | +--------------------+ +---------------+ |
| | | Device-Specific | | | Device-Specific |
| | +-------------------------------------------------+ | +-------------------------------------------------+
| | ^ ^ | ^ ^
| | | | | | |
| v v v v v v
| +--------------------------------------------------------------------+ +--------------------------------------------------------------------+
| | Helpers and Support Classes | | Helpers and Support Classes |
| | +-------------+ +-------------+ +-------------+ +-------------+ | | +-------------+ +-------------+ +-------------+ +-------------+ |
| | | MC & V4L2 | | Buffers | | Sandboxing | | Plugins | | | | MC & V4L2 | | Buffers | | Sandboxing | | Plugins | |
| | | Support | | Allocator | | IPC | | Manager | | | | Support | | Allocator | | IPC | | Manager | |
| | +-------------+ +-------------+ +-------------+ +-------------+ | | +-------------+ +-------------+ +-------------+ +-------------+ |
| | +-------------+ +-------------+ | | +-------------+ +-------------+ |
| | | Pipeline | | ... | | | | Pipeline | | ... | |
| | | Runner | | | | | | Runner | | | |
| | +-------------+ +-------------+ | | +-------------+ +-------------+ |
| +--------------------------------------------------------------------+ +--------------------------------------------------------------------+
|
| /// Device-Specific Components /// Device-Specific Components
| ~~~ Sandboxing ~~~ Sandboxing
While offering a unified API towards upper layers, and presenting While offering a unified API towards upper layers, and presenting
itself as a single library, libcamera isn't monolithic. It exposes itself as a single library, libcamera isn't monolithic. It exposes