/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* Vimc Image Processing Algorithm module
*/
#include <libcamera/ipa/vimc_ipa_interface.h>
#include <fcntl.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include <iostream>
#include <libcamera/base/file.h>
#include <libcamera/base/log.h>
#include <libcamera/ipa/ipa_interface.h>
#include <libcamera/ipa/ipa_module_info.h>
#include "libcamera/internal/mapped_framebuffer.h"
namespace libcamera {
LOG_DEFINE_CATEGORY(IPAVimc)
class IPAVimc : public ipa::vimc::IPAVimcInterface
{
public:
IPAVimc();
~IPAVimc();
int init(const IPASettings &settings,
const ipa::vimc::IPAOperationCode code,
const Flags<ipa::vimc::TestFlag> inFlags,
Flags<ipa::vimc::TestFlag> *outFlags) override;
int start() override;
void stop() override;
int configure(const IPACameraSensorInfo &sensorInfo,
const std::map<unsigned int, IPAStream> &streamConfig,
const std::map<unsigned int, ControlInfoMap> &entityControls) override;
void mapBuffers(const std::vector<IPABuffer> &buffers) override;
void unmapBuffers(const std::vector<unsigned int> &ids) override;
void queueRequest(uint32_t frame, const ControlList &controls) override;
void fillParamsBuffer(uint32_t frame, uint32_t bufferId) override;
private:
void initTrace();
void trace(enum ipa::vimc::IPAOperationCode operation);
int fd_;
std::map<unsigned int, MappedFrameBuffer> buffers_;
};
IPAVimc::IPAVimc()
: fd_(-1)
{
initTrace();
}
IPAVimc::~IPAVimc()
{
if (fd_ != -1)
::close(fd_);
}
int IPAVimc::init(const IPASettings &settings,
const ipa::vimc::IPAOperationCode code,
const Flags<ipa::vimc::TestFlag> inFlags,
Flags<ipa::vimc::TestFlag> *outFlags)
{
trace(ipa::vimc::IPAOperationInit);
LOG(IPAVimc, Debug)
<< "initializing vimc IPA with configuration file "
<< settings.configurationFile;
LOG(IPAVimc, Debug) << "Got opcode " << code;
LOG(IPAVimc, Debug)
<< "Flag 2 was "
<< (inFlags & ipa::vimc::TestFlag::Flag2 ? "" : "not ")
<< "set";
*outFlags |= ipa::vimc::TestFlag::Flag1;
File conf(settings.configurationFile);
if (!conf.open(File::OpenModeFlag::ReadOnly)) {
LOG(IPAVimc, Error) << "Failed to open configuration file";
return -EINVAL;
}
return 0;
}
int IPAVimc::start()
{
trace(ipa::vimc::IPAOperationStart);
LOG(IPAVimc, Debug) << "start vimc IPA!";
return 0;
}
void IPAVimc::stop()
{
trace(ipa::vimc::IPAOperationStop);
LOG(IPAVimc, Debug) << "stop vimc IPA!";
}
int IPAVimc::configure([[maybe_unused]] const IPACameraSensorInfo &sensorInfo,
[[maybe_unused]] const std::map<unsigned int, IPAStream> &streamConfig,
[[maybe_unused]] const std::map<unsigned int, ControlInfoMap> &entityControls)
{
LOG(IPAVimc, Debug) << "configure()";
return 0;
}
void IPAVimc::mapBuffers(const std::vector<IPABuffer> &buffers)
{
for (const IPABuffer &buffer : buffers) {
const FrameBuffer fb(buffer.planes);
buffers_.emplace(std::piecewise_construct,
std::forward_as_tuple(buffer.id),
std::forward_as_tuple(&fb, MappedFrameBuffer::MapFlag::Read));
}
}
void IPAVimc::unmapBuffers(const std::vector<unsigned int> &ids)
{
for (unsigned int id : ids) {
auto it = buffers_.find(id);
if (it == buffers_.end())
continue;
buffers_.erase(it);
}
}
void IPAVimc::queueRequest([[maybe_unused]] uint32_t frame,
[[maybe_unused]] const ControlList &controls)
{
}
void IPAVimc::fillParamsBuffer([[maybe_unused]] uint32_t frame, uint32_t bufferId)
{
auto it = buffers_.find(bufferId);
if (it == buffers_.end()) {
LOG(IPAVimc, Error) << "Could not find parameter buffer";
return;
}
Flags<ipa::vimc::TestFlag> flags;
paramsBufferReady.emit(bufferId, flags);
}
void IPAVimc::initTrace()
{
struct stat fifoStat;
int ret = stat(ipa::vimc::VimcIPAFIFOPath.c_str(), &fifoStat);
if (ret)
return;
ret = ::open(ipa::vimc::VimcIPAFIFOPath.c_str(), O_WRONLY | O_CLOEXEC);
if (ret < 0) {
ret = errno;
LOG(IPAVimc, Error) << "Failed to open vimc IPA test FIFO: "
<< strerror(ret);
return;
}
fd_ = ret;
}
void IPAVimc::trace(enum ipa::vimc::IPAOperationCode operation)
{
if (fd_ < 0)
return;
int ret = ::write(fd_, &operation, sizeof(operation));
if (ret < 0) {
ret = errno;
LOG(IPAVimc, Error) << "Failed to write to vimc IPA test FIFO: "
<< strerror(ret);
}
}
/*
* External IPA module interface
*/
extern "C" {
const struct IPAModuleInfo ipaModuleInfo = {
IPA_MODULE_API_VERSION,
0,
"vimc",
"vimc",
};
IPAInterface *ipaCreate()
{
return new IPAVimc();
}
}
} /* namespace libcamera */
ef='#n43'>43</a>
<a id='n44' href='#n44'>44</a>
<a id='n45' href='#n45'>45</a>
<a id='n46' href='#n46'>46</a>
<a id='n47' href='#n47'>47</a>
<a id='n48' href='#n48'>48</a>
<a id='n49' href='#n49'>49</a>
<a id='n50' href='#n50'>50</a>
<a id='n51' href='#n51'>51</a>
<a id='n52' href='#n52'>52</a>
<a id='n53' href='#n53'>53</a>
<a id='n54' href='#n54'>54</a>
<a id='n55' href='#n55'>55</a>
<a id='n56' href='#n56'>56</a>
<a id='n57' href='#n57'>57</a>
<a id='n58' href='#n58'>58</a>
<a id='n59' href='#n59'>59</a>
<a id='n60' href='#n60'>60</a>
<a id='n61' href='#n61'>61</a>
<a id='n62' href='#n62'>62</a>
<a id='n63' href='#n63'>63</a>
<a id='n64' href='#n64'>64</a>
<a id='n65' href='#n65'>65</a>
<a id='n66' href='#n66'>66</a>
<a id='n67' href='#n67'>67</a>
<a id='n68' href='#n68'>68</a>
<a id='n69' href='#n69'>69</a>
<a id='n70' href='#n70'>70</a>
<a id='n71' href='#n71'>71</a>
<a id='n72' href='#n72'>72</a>
<a id='n73' href='#n73'>73</a>
<a id='n74' href='#n74'>74</a>
<a id='n75' href='#n75'>75</a>
<a id='n76' href='#n76'>76</a>
<a id='n77' href='#n77'>77</a>
<a id='n78' href='#n78'>78</a>
<a id='n79' href='#n79'>79</a>
<a id='n80' href='#n80'>80</a>
<a id='n81' href='#n81'>81</a>
<a id='n82' href='#n82'>82</a>
<a id='n83' href='#n83'>83</a>
<a id='n84' href='#n84'>84</a>
<a id='n85' href='#n85'>85</a>
<a id='n86' href='#n86'>86</a>
<a id='n87' href='#n87'>87</a>
<a id='n88' href='#n88'>88</a>
<a id='n89' href='#n89'>89</a>
<a id='n90' href='#n90'>90</a>
<a id='n91' href='#n91'>91</a>
<a id='n92' href='#n92'>92</a>
<a id='n93' href='#n93'>93</a>
<a id='n94' href='#n94'>94</a>
<a id='n95' href='#n95'>95</a>
<a id='n96' href='#n96'>96</a>
<a id='n97' href='#n97'>97</a>
<a id='n98' href='#n98'>98</a>
<a id='n99' href='#n99'>99</a>
<a id='n100' href='#n100'>100</a>
<a id='n101' href='#n101'>101</a>
<a id='n102' href='#n102'>102</a>
<a id='n103' href='#n103'>103</a>
<a id='n104' href='#n104'>104</a>
<a id='n105' href='#n105'>105</a>
<a id='n106' href='#n106'>106</a>
<a id='n107' href='#n107'>107</a>
<a id='n108' href='#n108'>108</a>
<a id='n109' href='#n109'>109</a>
<a id='n110' href='#n110'>110</a>
<a id='n111' href='#n111'>111</a>
<a id='n112' href='#n112'>112</a>
<a id='n113' href='#n113'>113</a>
<a id='n114' href='#n114'>114</a>
<a id='n115' href='#n115'>115</a>
<a id='n116' href='#n116'>116</a>
<a id='n117' href='#n117'>117</a>
<a id='n118' href='#n118'>118</a>
<a id='n119' href='#n119'>119</a>
<a id='n120' href='#n120'>120</a>
<a id='n121' href='#n121'>121</a>
<a id='n122' href='#n122'>122</a>
<a id='n123' href='#n123'>123</a>
<a id='n124' href='#n124'>124</a>
<a id='n125' href='#n125'>125</a>
<a id='n126' href='#n126'>126</a>
<a id='n127' href='#n127'>127</a>
<a id='n128' href='#n128'>128</a>
<a id='n129' href='#n129'>129</a>
<a id='n130' href='#n130'>130</a>
<a id='n131' href='#n131'>131</a>
<a id='n132' href='#n132'>132</a>
<a id='n133' href='#n133'>133</a>
<a id='n134' href='#n134'>134</a>
<a id='n135' href='#n135'>135</a>
<a id='n136' href='#n136'>136</a>
<a id='n137' href='#n137'>137</a>
<a id='n138' href='#n138'>138</a>
<a id='n139' href='#n139'>139</a>
<a id='n140' href='#n140'>140</a>
<a id='n141' href='#n141'>141</a>
<a id='n142' href='#n142'>142</a>
<a id='n143' href='#n143'>143</a>
<a id='n144' href='#n144'>144</a>
<a id='n145' href='#n145'>145</a>
<a id='n146' href='#n146'>146</a>
<a id='n147' href='#n147'>147</a>
<a id='n148' href='#n148'>148</a>
<a id='n149' href='#n149'>149</a>
<a id='n150' href='#n150'>150</a>
<a id='n151' href='#n151'>151</a>
<a id='n152' href='#n152'>152</a>
<a id='n153' href='#n153'>153</a>
<a id='n154' href='#n154'>154</a>
<a id='n155' href='#n155'>155</a>
<a id='n156' href='#n156'>156</a>
<a id='n157' href='#n157'>157</a>
<a id='n158' href='#n158'>158</a>
<a id='n159' href='#n159'>159</a>
<a id='n160' href='#n160'>160</a>
<a id='n161' href='#n161'>161</a>
<a id='n162' href='#n162'>162</a>
<a id='n163' href='#n163'>163</a>
<a id='n164' href='#n164'>164</a>
<a id='n165' href='#n165'>165</a>
<a id='n166' href='#n166'>166</a>
<a id='n167' href='#n167'>167</a>
<a id='n168' href='#n168'>168</a>
<a id='n169' href='#n169'>169</a>
<a id='n170' href='#n170'>170</a>
<a id='n171' href='#n171'>171</a>
<a id='n172' href='#n172'>172</a>
<a id='n173' href='#n173'>173</a>
<a id='n174' href='#n174'>174</a>
<a id='n175' href='#n175'>175</a>
<a id='n176' href='#n176'>176</a>
<a id='n177' href='#n177'>177</a>
<a id='n178' href='#n178'>178</a>
<a id='n179' href='#n179'>179</a>
<a id='n180' href='#n180'>180</a>
<a id='n181' href='#n181'>181</a>
<a id='n182' href='#n182'>182</a>
<a id='n183' href='#n183'>183</a>
<a id='n184' href='#n184'>184</a>
<a id='n185' href='#n185'>185</a>
<a id='n186' href='#n186'>186</a>
<a id='n187' href='#n187'>187</a>
<a id='n188' href='#n188'>188</a>
<a id='n189' href='#n189'>189</a>
<a id='n190' href='#n190'>190</a>
<a id='n191' href='#n191'>191</a>
<a id='n192' href='#n192'>192</a>
<a id='n193' href='#n193'>193</a>
<a id='n194' href='#n194'>194</a>
<a id='n195' href='#n195'>195</a>
<a id='n196' href='#n196'>196</a>
<a id='n197' href='#n197'>197</a>
<a id='n198' href='#n198'>198</a>
<a id='n199' href='#n199'>199</a>
<a id='n200' href='#n200'>200</a>
<a id='n201' href='#n201'>201</a>
<a id='n202' href='#n202'>202</a>
<a id='n203' href='#n203'>203</a>
<a id='n204' href='#n204'>204</a>
<a id='n205' href='#n205'>205</a>
<a id='n206' href='#n206'>206</a>
<a id='n207' href='#n207'>207</a>
<a id='n208' href='#n208'>208</a>
<a id='n209' href='#n209'>209</a>
<a id='n210' href='#n210'>210</a>
<a id='n211' href='#n211'>211</a>
<a id='n212' href='#n212'>212</a>
<a id='n213' href='#n213'>213</a>
<a id='n214' href='#n214'>214</a>
<a id='n215' href='#n215'>215</a>
<a id='n216' href='#n216'>216</a>
<a id='n217' href='#n217'>217</a>
<a id='n218' href='#n218'>218</a>
<a id='n219' href='#n219'>219</a>
<a id='n220' href='#n220'>220</a>
<a id='n221' href='#n221'>221</a>
<a id='n222' href='#n222'>222</a>
<a id='n223' href='#n223'>223</a>
<a id='n224' href='#n224'>224</a>
<a id='n225' href='#n225'>225</a>
<a id='n226' href='#n226'>226</a>
<a id='n227' href='#n227'>227</a>
<a id='n228' href='#n228'>228</a>
<a id='n229' href='#n229'>229</a>
<a id='n230' href='#n230'>230</a>
<a id='n231' href='#n231'>231</a>
<a id='n232' href='#n232'>232</a>
<a id='n233' href='#n233'>233</a>
<a id='n234' href='#n234'>234</a>
<a id='n235' href='#n235'>235</a>
<a id='n236' href='#n236'>236</a>
<a id='n237' href='#n237'>237</a>
<a id='n238' href='#n238'>238</a>
<a id='n239' href='#n239'>239</a>
<a id='n240' href='#n240'>240</a>
<a id='n241' href='#n241'>241</a>
<a id='n242' href='#n242'>242</a>
<a id='n243' href='#n243'>243</a>
<a id='n244' href='#n244'>244</a>
<a id='n245' href='#n245'>245</a>
<a id='n246' href='#n246'>246</a>
<a id='n247' href='#n247'>247</a>
<a id='n248' href='#n248'>248</a>
<a id='n249' href='#n249'>249</a>
<a id='n250' href='#n250'>250</a>
<a id='n251' href='#n251'>251</a>
<a id='n252' href='#n252'>252</a>
<a id='n253' href='#n253'>253</a>
<a id='n254' href='#n254'>254</a>
<a id='n255' href='#n255'>255</a>
<a id='n256' href='#n256'>256</a>
<a id='n257' href='#n257'>257</a>
<a id='n258' href='#n258'>258</a>
<a id='n259' href='#n259'>259</a>
<a id='n260' href='#n260'>260</a>
<a id='n261' href='#n261'>261</a>
<a id='n262' href='#n262'>262</a>
<a id='n263' href='#n263'>263</a>
<a id='n264' href='#n264'>264</a>
<a id='n265' href='#n265'>265</a>
<a id='n266' href='#n266'>266</a>
<a id='n267' href='#n267'>267</a>
<a id='n268' href='#n268'>268</a>
<a id='n269' href='#n269'>269</a>
<a id='n270' href='#n270'>270</a>
<a id='n271' href='#n271'>271</a>
<a id='n272' href='#n272'>272</a>
<a id='n273' href='#n273'>273</a>
<a id='n274' href='#n274'>274</a>
<a id='n275' href='#n275'>275</a>
<a id='n276' href='#n276'>276</a>
<a id='n277' href='#n277'>277</a>
<a id='n278' href='#n278'>278</a>
<a id='n279' href='#n279'>279</a>
<a id='n280' href='#n280'>280</a>
<a id='n281' href='#n281'>281</a>
<a id='n282' href='#n282'>282</a>
<a id='n283' href='#n283'>283</a>
<a id='n284' href='#n284'>284</a>
<a id='n285' href='#n285'>285</a>
<a id='n286' href='#n286'>286</a>
<a id='n287' href='#n287'>287</a>
<a id='n288' href='#n288'>288</a>
<a id='n289' href='#n289'>289</a>
<a id='n290' href='#n290'>290</a>
<a id='n291' href='#n291'>291</a>
<a id='n292' href='#n292'>292</a>
<a id='n293' href='#n293'>293</a>
<a id='n294' href='#n294'>294</a>
<a id='n295' href='#n295'>295</a>
<a id='n296' href='#n296'>296</a>
<a id='n297' href='#n297'>297</a>
<a id='n298' href='#n298'>298</a>
<a id='n299' href='#n299'>299</a>
<a id='n300' href='#n300'>300</a>
<a id='n301' href='#n301'>301</a>
<a id='n302' href='#n302'>302</a>
<a id='n303' href='#n303'>303</a>
<a id='n304' href='#n304'>304</a>
<a id='n305' href='#n305'>305</a>
<a id='n306' href='#n306'>306</a>
<a id='n307' href='#n307'>307</a>
<a id='n308' href='#n308'>308</a>
<a id='n309' href='#n309'>309</a>
<a id='n310' href='#n310'>310</a>
<a id='n311' href='#n311'>311</a>
<a id='n312' href='#n312'>312</a>
<a id='n313' href='#n313'>313</a>
<a id='n314' href='#n314'>314</a>
<a id='n315' href='#n315'>315</a>
<a id='n316' href='#n316'>316</a>
<a id='n317' href='#n317'>317</a>
<a id='n318' href='#n318'>318</a>
<a id='n319' href='#n319'>319</a>
<a id='n320' href='#n320'>320</a>
<a id='n321' href='#n321'>321</a>
<a id='n322' href='#n322'>322</a>
<a id='n323' href='#n323'>323</a>
<a id='n324' href='#n324'>324</a>
<a id='n325' href='#n325'>325</a>
<a id='n326' href='#n326'>326</a>
<a id='n327' href='#n327'>327</a>
<a id='n328' href='#n328'>328</a>
<a id='n329' href='#n329'>329</a>
<a id='n330' href='#n330'>330</a>
<a id='n331' href='#n331'>331</a>
<a id='n332' href='#n332'>332</a>
<a id='n333' href='#n333'>333</a>
<a id='n334' href='#n334'>334</a>
<a id='n335' href='#n335'>335</a>
<a id='n336' href='#n336'>336</a>
<a id='n337' href='#n337'>337</a>
<a id='n338' href='#n338'>338</a>
<a id='n339' href='#n339'>339</a>
<a id='n340' href='#n340'>340</a>
</pre></td>
<td class='lines'><pre><code><span class="hl slc">#!/usr/bin/env python3</span>
<span class="hl slc"># SPDX-License-Identifier: BSD-3-Clause</span>
<span class="hl slc"># Copyright (C) 2022, Tomi Valkeinen <tomi.valkeinen@ideasonboard.com></span>
<span class="hl slc"># A simple libcamera capture example</span>
<span class="hl slc">#</span>
<span class="hl slc"># This is a python version of simple-cam from:</span>
<span class="hl slc"># https://git.libcamera.org/libcamera/simple-cam.git</span>
<span class="hl slc">#</span>
<span class="hl slc"># \todo Move to simple-cam repository when the Python API has stabilized more</span>
<span class="hl kwa">import</span> libcamera <span class="hl kwa">as</span> libcam
<span class="hl kwa">import</span> selectors
<span class="hl kwa">import</span> sys
<span class="hl kwa">import</span> time
TIMEOUT_SEC <span class="hl opt">=</span> <span class="hl num">3</span>
<span class="hl kwa">def</span> <span class="hl kwd">handle_camera_event</span><span class="hl opt">(</span>cm<span class="hl opt">):</span>
<span class="hl slc"># cm.get_ready_requests() returns the ready requests, which in our case</span>
<span class="hl slc"># should almost always return a single Request, but in some cases there</span>
<span class="hl slc"># could be multiple or none.</span>
reqs <span class="hl opt">=</span> cm<span class="hl opt">.</span><span class="hl kwd">get_ready_requests</span><span class="hl opt">()</span>
<span class="hl slc"># Process the captured frames</span>
<span class="hl kwa">for</span> req <span class="hl kwa">in</span> reqs<span class="hl opt">:</span>
<span class="hl kwd">process_request</span><span class="hl opt">(</span>req<span class="hl opt">)</span>
<span class="hl kwa">def</span> <span class="hl kwd">process_request</span><span class="hl opt">(</span>request<span class="hl opt">):</span>
<span class="hl kwa">global</span> camera
<span class="hl kwa">print</span><span class="hl opt">()</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">'Request completed:</span> <span class="hl ipl">{request}</span><span class="hl str">'</span><span class="hl opt">)</span>
<span class="hl slc"># When a request has completed, it is populated with a metadata control</span>
<span class="hl slc"># list that allows an application to determine various properties of</span>
<span class="hl slc"># the completed request. This can include the timestamp of the Sensor</span>
<span class="hl slc"># capture, or its gain and exposure values, or properties from the IPA</span>
<span class="hl slc"># such as the state of the 3A algorithms.</span>
<span class="hl slc">#</span>
<span class="hl slc"># To examine each request, print all the metadata for inspection. A custom</span>
<span class="hl slc"># application can parse each of these items and process them according to</span>
<span class="hl slc"># its needs.</span>
requestMetadata <span class="hl opt">=</span> request<span class="hl opt">.</span>metadata
<span class="hl kwa">for</span> <span class="hl kwb">id</span><span class="hl opt">,</span> value <span class="hl kwa">in</span> requestMetadata<span class="hl opt">.</span><span class="hl kwd">items</span><span class="hl opt">():</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">'</span><span class="hl esc">\t</span><span class="hl str">{id.name} =</span> <span class="hl ipl">{value}</span><span class="hl str">'</span><span class="hl opt">)</span>
<span class="hl slc"># Each buffer has its own FrameMetadata to describe its state, or the</span>
<span class="hl slc"># usage of each buffer. While in our simple capture we only provide one</span>
<span class="hl slc"># buffer per request, a request can have a buffer for each stream that</span>
<span class="hl slc"># is established when configuring the camera.</span>
<span class="hl slc">#</span>
<span class="hl slc"># This allows a viewfinder and a still image to be processed at the</span>
<span class="hl slc"># same time, or to allow obtaining the RAW capture buffer from the</span>
<span class="hl slc"># sensor along with the image as processed by the ISP.</span>
buffers <span class="hl opt">=</span> request<span class="hl opt">.</span>buffers
<span class="hl kwa">for</span> _<span class="hl opt">,</span> <span class="hl kwb">buffer</span> <span class="hl kwa">in</span> buffers<span class="hl opt">.</span><span class="hl kwd">items</span><span class="hl opt">():</span>
metadata <span class="hl opt">=</span> <span class="hl kwb">buffer</span><span class="hl opt">.</span>metadata
<span class="hl slc"># Print some information about the buffer which has completed.</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">' seq: {metadata.sequence:06} timestamp: {metadata.timestamp} bytesused: '</span> <span class="hl opt">+</span>
<span class="hl str">'/'</span><span class="hl opt">.</span><span class="hl kwd">join</span><span class="hl opt">([</span><span class="hl kwb">str</span><span class="hl opt">(</span>p<span class="hl opt">.</span>bytes_used<span class="hl opt">)</span> <span class="hl kwa">for</span> p <span class="hl kwa">in</span> metadata<span class="hl opt">.</span>planes<span class="hl opt">]))</span>
<span class="hl slc"># Image data can be accessed here, but the FrameBuffer</span>
<span class="hl slc"># must be mapped by the application</span>
<span class="hl slc"># Re-queue the Request to the camera.</span>
request<span class="hl opt">.</span><span class="hl kwd">reuse</span><span class="hl opt">()</span>
camera<span class="hl opt">.</span><span class="hl kwd">queue_request</span><span class="hl opt">(</span>request<span class="hl opt">)</span>
<span class="hl slc"># ----------------------------------------------------------------------------</span>
<span class="hl slc"># Camera Naming.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Applications are responsible for deciding how to name cameras, and present</span>
<span class="hl slc"># that information to the users. Every camera has a unique identifier, though</span>
<span class="hl slc"># this string is not designed to be friendly for a human reader.</span>
<span class="hl slc">#</span>
<span class="hl slc"># To support human consumable names, libcamera provides camera properties</span>
<span class="hl slc"># that allow an application to determine a naming scheme based on its needs.</span>
<span class="hl slc">#</span>
<span class="hl slc"># In this example, we focus on the location property, but also detail the</span>
<span class="hl slc"># model string for external cameras, as this is more likely to be visible</span>
<span class="hl slc"># information to the user of an externally connected device.</span>
<span class="hl slc">#</span>
<span class="hl slc"># The unique camera ID is appended for informative purposes.</span>
<span class="hl slc">#</span>
<span class="hl kwa">def</span> <span class="hl kwd">camera_name</span><span class="hl opt">(</span>camera<span class="hl opt">):</span>
props <span class="hl opt">=</span> camera<span class="hl opt">.</span>properties
location <span class="hl opt">=</span> props<span class="hl opt">.</span><span class="hl kwd">get</span><span class="hl opt">(</span>libcam<span class="hl opt">.</span>properties<span class="hl opt">.</span>Location<span class="hl opt">,</span> <span class="hl kwa">None</span><span class="hl opt">)</span>
<span class="hl kwa">if</span> location <span class="hl opt">==</span> libcam<span class="hl opt">.</span>properties<span class="hl opt">.</span>LocationEnum<span class="hl opt">.</span>Front<span class="hl opt">:</span>
name <span class="hl opt">=</span> <span class="hl str">'Internal front camera'</span>
<span class="hl kwa">elif</span> location <span class="hl opt">==</span> libcam<span class="hl opt">.</span>properties<span class="hl opt">.</span>LocationEnum<span class="hl opt">.</span>Back<span class="hl opt">:</span>
name <span class="hl opt">=</span> <span class="hl str">'Internal back camera'</span>
<span class="hl kwa">elif</span> location <span class="hl opt">==</span> libcam<span class="hl opt">.</span>properties<span class="hl opt">.</span>LocationEnum<span class="hl opt">.</span>External<span class="hl opt">:</span>
name <span class="hl opt">=</span> <span class="hl str">'External camera'</span>
<span class="hl kwa">if</span> libcam<span class="hl opt">.</span>properties<span class="hl opt">.</span>Model <span class="hl kwa">in</span> props<span class="hl opt">:</span>
name <span class="hl opt">+=</span> f<span class="hl str">' "{props[libcam.properties.Model]}"'</span>
<span class="hl kwa">else</span><span class="hl opt">:</span>
name <span class="hl opt">=</span> <span class="hl str">'Undefined location'</span>
name <span class="hl opt">+=</span> f<span class="hl str">' ({camera.id})'</span>
<span class="hl kwa">return</span> name
<span class="hl kwa">def</span> <span class="hl kwd">main</span><span class="hl opt">():</span>
<span class="hl kwa">global</span> camera
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Get the Camera Manager.</span>
<span class="hl slc">#</span>
<span class="hl slc"># The Camera Manager is responsible for enumerating all the Camera</span>
<span class="hl slc"># in the system, by associating Pipeline Handlers with media entities</span>
<span class="hl slc"># registered in the system.</span>
<span class="hl slc">#</span>
<span class="hl slc"># The CameraManager provides a list of available Cameras that</span>
<span class="hl slc"># applications can operate on.</span>
<span class="hl slc">#</span>
<span class="hl slc"># There can only be a single CameraManager within any process space.</span>
cm <span class="hl opt">=</span> libcam<span class="hl opt">.</span>CameraManager<span class="hl opt">.</span><span class="hl kwd">singleton</span><span class="hl opt">()</span>
<span class="hl slc"># Just as a test, generate names of the Cameras registered in the</span>
<span class="hl slc"># system, and list them.</span>
<span class="hl kwa">for</span> camera <span class="hl kwa">in</span> cm<span class="hl opt">.</span>cameras<span class="hl opt">:</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">' - {camera_name(camera)}'</span><span class="hl opt">)</span>
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Camera</span>
<span class="hl slc">#</span>
<span class="hl slc"># Camera are entities created by pipeline handlers, inspecting the</span>
<span class="hl slc"># entities registered in the system and reported to applications</span>
<span class="hl slc"># by the CameraManager.</span>
<span class="hl slc">#</span>
<span class="hl slc"># In general terms, a Camera corresponds to a single image source</span>
<span class="hl slc"># available in the system, such as an image sensor.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Application lock usage of Camera by 'acquiring' them.</span>
<span class="hl slc"># Once done with it, application shall similarly 'release' the Camera.</span>
<span class="hl slc">#</span>
<span class="hl slc"># As an example, use the first available camera in the system after</span>
<span class="hl slc"># making sure that at least one camera is available.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Cameras can be obtained by their ID or their index, to demonstrate</span>
<span class="hl slc"># this, the following code gets the ID of the first camera; then gets</span>
<span class="hl slc"># the camera associated with that ID (which is of course the same as</span>
<span class="hl slc"># cm.cameras[0]).</span>
<span class="hl kwa">if not</span> cm<span class="hl opt">.</span>cameras<span class="hl opt">:</span>
<span class="hl kwa">print</span><span class="hl opt">(</span><span class="hl str">'No cameras were identified on the system.'</span><span class="hl opt">)</span>
<span class="hl kwa">return</span> <span class="hl opt">-</span><span class="hl num">1</span>
camera_id <span class="hl opt">=</span> cm<span class="hl opt">.</span>cameras<span class="hl opt">[</span><span class="hl num">0</span><span class="hl opt">].</span><span class="hl kwb">id</span>
camera <span class="hl opt">=</span> cm<span class="hl opt">.</span><span class="hl kwd">get</span><span class="hl opt">(</span>camera_id<span class="hl opt">)</span>
camera<span class="hl opt">.</span><span class="hl kwd">acquire</span><span class="hl opt">()</span>
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Stream</span>
<span class="hl slc">#</span>
<span class="hl slc"># Each Camera supports a variable number of Stream. A Stream is</span>
<span class="hl slc"># produced by processing data produced by an image source, usually</span>
<span class="hl slc"># by an ISP.</span>
<span class="hl slc">#</span>
<span class="hl slc"># +-------------------------------------------------------+</span>
<span class="hl slc"># | Camera |</span>
<span class="hl slc"># | +-----------+ |</span>
<span class="hl slc"># | +--------+ | |------> [ Main output ] |</span>
<span class="hl slc"># | | Image | | | |</span>
<span class="hl slc"># | | |---->| ISP |------> [ Viewfinder ] |</span>
<span class="hl slc"># | | Source | | | |</span>
<span class="hl slc"># | +--------+ | |------> [ Still Capture ] |</span>
<span class="hl slc"># | +-----------+ |</span>
<span class="hl slc"># +-------------------------------------------------------+</span>
<span class="hl slc">#</span>
<span class="hl slc"># The number and capabilities of the Stream in a Camera are</span>
<span class="hl slc"># a platform dependent property, and it's the pipeline handler</span>
<span class="hl slc"># implementation that has the responsibility of correctly</span>
<span class="hl slc"># report them.</span>
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Camera Configuration.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Camera configuration is tricky! It boils down to assign resources</span>
<span class="hl slc"># of the system (such as DMA engines, scalers, format converters) to</span>
<span class="hl slc"># the different image streams an application has requested.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Depending on the system characteristics, some combinations of</span>
<span class="hl slc"># sizes, formats and stream usages might or might not be possible.</span>
<span class="hl slc">#</span>
<span class="hl slc"># A Camera produces a CameraConfigration based on a set of intended</span>
<span class="hl slc"># roles for each Stream the application requires.</span>
config <span class="hl opt">=</span> camera<span class="hl opt">.</span><span class="hl kwd">generate_configuration</span><span class="hl opt">([</span>libcam<span class="hl opt">.</span>StreamRole<span class="hl opt">.</span>Viewfinder<span class="hl opt">])</span>
<span class="hl slc"># The CameraConfiguration contains a StreamConfiguration instance</span>
<span class="hl slc"># for each StreamRole requested by the application, provided</span>
<span class="hl slc"># the Camera can support all of them.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Each StreamConfiguration has default size and format, assigned</span>
<span class="hl slc"># by the Camera depending on the Role the application has requested.</span>
stream_config <span class="hl opt">=</span> config<span class="hl opt">.</span><span class="hl kwd">at</span><span class="hl opt">(</span><span class="hl num">0</span><span class="hl opt">)</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">'Default viewfinder configuration is:</span> <span class="hl ipl">{stream_config}</span><span class="hl str">'</span><span class="hl opt">)</span>
<span class="hl slc"># Each StreamConfiguration parameter which is part of a</span>
<span class="hl slc"># CameraConfiguration can be independently modified by the</span>
<span class="hl slc"># application.</span>
<span class="hl slc">#</span>
<span class="hl slc"># In order to validate the modified parameter, the CameraConfiguration</span>
<span class="hl slc"># should be validated -before- the CameraConfiguration gets applied</span>
<span class="hl slc"># to the Camera.</span>
<span class="hl slc">#</span>
<span class="hl slc"># The CameraConfiguration validation process adjusts each</span>
<span class="hl slc"># StreamConfiguration to a valid value.</span>
<span class="hl slc"># Validating a CameraConfiguration -before- applying it will adjust it</span>
<span class="hl slc"># to a valid configuration which is as close as possible to the one</span>
<span class="hl slc"># requested.</span>
config<span class="hl opt">.</span><span class="hl kwd">validate</span><span class="hl opt">()</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">'Validated viewfinder configuration is:</span> <span class="hl ipl">{stream_config}</span><span class="hl str">'</span><span class="hl opt">)</span>
<span class="hl slc"># Once we have a validated configuration, we can apply it to the</span>
<span class="hl slc"># Camera.</span>
camera<span class="hl opt">.</span><span class="hl kwd">configure</span><span class="hl opt">(</span>config<span class="hl opt">)</span>
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Buffer Allocation</span>
<span class="hl slc">#</span>
<span class="hl slc"># Now that a camera has been configured, it knows all about its</span>
<span class="hl slc"># Streams sizes and formats. The captured images need to be stored in</span>
<span class="hl slc"># framebuffers which can either be provided by the application to the</span>
<span class="hl slc"># library, or allocated in the Camera and exposed to the application</span>
<span class="hl slc"># by libcamera.</span>
<span class="hl slc">#</span>
<span class="hl slc"># An application may decide to allocate framebuffers from elsewhere,</span>
<span class="hl slc"># for example in memory allocated by the display driver that will</span>
<span class="hl slc"># render the captured frames. The application will provide them to</span>
<span class="hl slc"># libcamera by constructing FrameBuffer instances to capture images</span>
<span class="hl slc"># directly into.</span>
<span class="hl slc">#</span>
<span class="hl slc"># Alternatively libcamera can help the application by exporting</span>
<span class="hl slc"># buffers allocated in the Camera using a FrameBufferAllocator</span>
<span class="hl slc"># instance and referencing a configured Camera to determine the</span>
<span class="hl slc"># appropriate buffer size and types to create.</span>
allocator <span class="hl opt">=</span> libcam<span class="hl opt">.</span><span class="hl kwd">FrameBufferAllocator</span><span class="hl opt">(</span>camera<span class="hl opt">)</span>
<span class="hl kwa">for</span> cfg <span class="hl kwa">in</span> config<span class="hl opt">:</span>
allocated <span class="hl opt">=</span> allocator<span class="hl opt">.</span><span class="hl kwd">allocate</span><span class="hl opt">(</span>cfg<span class="hl opt">.</span>stream<span class="hl opt">)</span>
<span class="hl kwa">print</span><span class="hl opt">(</span>f<span class="hl str">'Allocated</span> <span class="hl ipl">{allocated}</span> <span class="hl str">buffers for stream'</span><span class="hl opt">)</span>
<span class="hl slc"># --------------------------------------------------------------------</span>
<span class="hl slc"># Frame Capture</span>
<span class="hl slc">#</span>
<span class="hl slc"># libcamera frames capture model is based on the 'Request' concept.</span>
<span class="hl slc"># For each frame a Request has to be queued to the Camera.</span>
<span class="hl slc">#</span>
<span class="hl slc"># A Request refers to (at least one) Stream for which a Buffer that</span>
<span class="hl slc"># will be filled with image data shall be added to the Request.</span>
<span class="hl slc">#</span>
<span class="hl slc"># A Request is associated with a list of Controls, which are tunable</span>
<span class="hl slc"># parameters (similar to v4l2_controls) that have to be applied to