/* SPDX-License-Identifier: CC-BY-SA-4.0 */ html { background-image: linear-gradient(to bottom right, #4895e1, #56c3ae); background-size: cover; background-repeat: no-repeat; min-height: 100vh; } body { color: rgb(0, 0, 0, 0.65); font-family: Arial, sans-serif; margin: 0px; } a { color: unset; font-weight: bold; text-decoration: underline dotted; } a.headerlink { color: rgba(0, 0, 0, 0.2); font-size: 70%; padding-left: 5px; visibility: hidden; } a.toc-backref { text-decoration: none; } h1:hover a.headerlink, h2:hover a.headerlink, h3:hover a.headerlink, h4:hover a.headerlink, h5:hover a.headerlink, h6:hover a.headerlink { visibility: visible; } dt { font-weight: bold; } .text-light { color: rgba(255, 255, 255, 0.3); } div#navbar { margin-top: 0px; } div.navbar-brand { color: rgb(255, 255, 255, 1.0); float: left; font-size: 36px; margin: 0px 24px 24px 24px; } div.navbar-logo { float: left; font-family: monospace; font-size: 18px; font-weight: bold; white-space: pre; } div.navbar-name { float: left; color: rgb(255, 255, 255, 1.0); font-size: 34px; margin-top: 31px; margin-left: 10px; padding-top: 1px; } div.navbar { float: right; } div.navbar p.caption { height: 0px; margin: 0px; visibility: hidden; } div.navbar ul { float: left; font-size: 24px; list-style: none; margin-top: 42px; margin-right: 20px; padding-left: 0px; } div.navbar a { font-weight: normal; text-decoration: none; } div.navbar li { float: left; margin-left: 20px; margin-right: 20px; position: relative; } div.navbar li a { color: rgb(255, 255, 255, 0.5); position: relative; } div.navbar li a:before { content: ""; position: absolute; width: 100%; height: 2px; bottom: 0; left: 0; background-color: rgb(255, 255, 255, 0.5); visibility: hidden; transform: scaleX(0); transition: all 0.3s ease-in-out 0s; } div.navbar li a:hover { color: rgb(255, 255, 255, 1.0); } div.navbar li a:hover:before { visibility: visible; transform: scaleX(1); } div.navbar li.current a { color: rgb(255, 255, 255, 1.0); } div.navbar li.current a:before { visibility: visible; transform: unset; transition: unset; } div.navbar div.searchbox { background-color: white; float: right; margin-right: 50px; margin-top: 42px; } div.navbar input[type=text] { border-width: 0; height: 2em; margin-left: 10px; margin-right: 5px; } div.navbar input[type=submit] { background-color: white; background-image: url(../search.png); background-repeat: no-repeat; border-width: 0; color: rgba(0, 0, 0, 0); margin-right: 2px; width: 20px; } div#frontpage { clear: both; padding-top: 50px; margin-left: auto; margin-right: auto; width: 75%; display: flex; justify-content: space-between; } div#frontpage > div.block { background-color: white; border-radius: 5px; box-shadow: 0 4px 16px 0 rgba(0, 0, 0, 0.2), 0 6px 40px 0 rgba(0, 0, 0, 0.19); color: rgb(0, 0, 0, 0.5); font-size: 20px; margin-bottom: 40px; margin-right: 20px; margin-left: 20px; padding: 20px 60px 20px 60px; text-align: center; width: 50%; } div#frontpage > div.block h1 { font-size: 64px; padding-left: 20%; padding-right: 20%; text-align: center; text-shadow: 4px 4px 5px; } div#content { background-color: white; clear: both; padding-top: 50px; padding-bottom: 50px; margin-left: 0px; margin-right: 0px; } div#content > div.block { font-size: 16px; margin-right: 0px; margin-left: 0px; max-width: 1280px; padding: 0px 60px 0px 60px; text-align: justify; } div#content > div.block h1 { font-size: 40px; margin-top: 0px; text-align: left; } div#content > div.block > div.section { max-width: 800px; } div.local.topic { float: right; background-color: #fcfcff; border: 1px dotted #4896e0; margin-left: 20px; margin-right: 0px; max-width: 15em; padding: 10px 20px 10px 10px; text-align: left; } div.local.topic ul { padding-left: 20px; margin-bottom: 5px; } div.local.topic > ul:before { content: "Contents"; display: block; font-weight: bold; margin-bottom: 10px; } div.local.topic a { font-weight: normal; padding-left: 10px; text-decoration: none; } div.highlight-shell > div.highlight > pre, pre.console { background-color: #fcfcff; border: 1px dotted #4896e0; margin-left: 0em; padding: 10px; text-align: left; } div.highlight-default > div.highlight > pre, pre.diagram { background-color: #fcfcff; border: 1px dotted #4896e0; font-size: 12px; margin-left: 0em; padding: 10px; text-align: left; width: 47em; } div#signature { color: rgb(255, 255, 255, 0.5); margin: 20px; float: right; font-size: 12px; } #libcamera div.toctree-wrapper { height: 0px; margin: 0px; padding: 0px; visibility: hidden; } 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> </pre></td> <td class='lines'><pre><code><span class="hl com">/* SPDX-License-Identifier: LGPL-2.1-or-later */</span> <span class="hl com">/*</span> <span class="hl com"> * Copyright (C) 2018, Google Inc.</span> <span class="hl com"> *</span> <span class="hl com"> * device_enumerator.cpp - Enumeration and matching</span> <span class="hl com"> */</span> <span class="hl ppc">#include</span> <span class="hl pps">"device_enumerator.h"</span><span class="hl ppc"></span> <span class="hl ppc">#include</span> <span class="hl pps">"device_enumerator_sysfs.h"</span><span class="hl ppc"></span> <span class="hl ppc">#include</span> <span class="hl pps">"device_enumerator_udev.h"</span><span class="hl ppc"></span> <span class="hl ppc">#include <string.h></span> <span class="hl ppc">#include</span> <span class="hl pps">"log.h"</span><span class="hl ppc"></span> <span class="hl ppc">#include</span> <span class="hl pps">"media_device.h"</span><span class="hl ppc"></span> <span class="hl ppc">#include</span> <span class="hl pps">"utils.h"</span><span class="hl ppc"></span> <span class="hl com">/**</span> <span class="hl com"> * \file device_enumerator.h</span> <span class="hl com"> * \brief Enumeration and matching of media devices</span> <span class="hl com"> *</span> <span class="hl com"> * The purpose of device enumeration and matching is to find media devices in</span> <span class="hl com"> * the system and map them to pipeline handlers.</span> <span class="hl com"> *</span> <span class="hl com"> * At the core of the enumeration is the DeviceEnumerator class, responsible</span> <span class="hl com"> * for enumerating all media devices in the system. It handles all interactions</span> <span class="hl com"> * with the operating system in a platform-specific way. For each media device</span> <span class="hl com"> * found an instance of MediaDevice is created to store information about the</span> <span class="hl com"> * device gathered from the kernel through the Media Controller API.</span> <span class="hl com"> *</span> <span class="hl com"> * The DeviceEnumerator can enumerate all or specific media devices in the</span> <span class="hl com"> * system. When a new media device is added the enumerator creates a</span> <span class="hl com"> * corresponding MediaDevice instance.</span> <span class="hl com"> *</span> <span class="hl com"> * The enumerator supports searching among enumerated devices based on criteria</span> <span class="hl com"> * expressed in a DeviceMatch object.</span> <span class="hl com"> *</span> <span class="hl com"> * \todo Add sysfs based device enumerator.</span> <span class="hl com"> */</span> <span class="hl kwa">namespace</span> libcamera <span class="hl opt">{</span> <span class="hl kwd">LOG_DEFINE_CATEGORY</span><span class="hl opt">(</span>DeviceEnumerator<span class="hl opt">)</span> <span class="hl com">/**</span> <span class="hl com"> * \class DeviceMatch</span> <span class="hl com"> * \brief Description of a media device search pattern</span> <span class="hl com"> *</span> <span class="hl com"> * The DeviceMatch class describes a media device using properties from the</span> <span class="hl com"> * Media Controller struct media_device_info, entity names in the media graph</span> <span class="hl com"> * or other properties that can be used to identify a media device.</span> <span class="hl com"> *</span> <span class="hl com"> * The description is meant to be filled by pipeline managers and passed to a</span> <span class="hl com"> * device enumerator to find matching media devices.</span> <span class="hl com"> *</span> <span class="hl com"> * A DeviceMatch is created with a specific Linux device driver in mind,</span> <span class="hl com"> * therefore the name of the driver is a required property. One or more Entity</span> <span class="hl com"> * names can be added as match criteria.</span> <span class="hl com"> *</span> <span class="hl com"> * Pipeline handlers are recommended to add entities to DeviceMatch as</span> <span class="hl com"> * appropriare to ensure that the media device they need can be uniquely</span> <span class="hl com"> * identified. This is useful when the corresponding kernel driver can produce</span> <span class="hl com"> * different graphs, for instance as a result of different driver versions or</span> <span class="hl com"> * hardware configurations, and not all those graphs are suitable for a pipeline</span> <span class="hl com"> * handler.</span> <span class="hl com"> */</span> <span class="hl com">/**</span> <span class="hl com"> * \brief Construct a media device search pattern</span> <span class="hl com"> * \param[in] driver The Linux device driver name that created the media device</span> <span class="hl com"> */</span> <span class="hl kwc">DeviceMatch</span><span class="hl opt">::</span><span class="hl kwd">DeviceMatch</span><span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl opt">&</span>driver<span class="hl opt">)</span> <span class="hl opt">:</span> <span class="hl kwd">driver_</span><span class="hl opt">(</span>driver<span class="hl opt">)</span> <span class="hl opt">{</span> <span class="hl opt">}</span> <span class="hl com">/**</span> <span class="hl com"> * \brief Add a media entity name to the search pattern</span> <span class="hl com"> * \param[in] entity The name of the entity in the media graph</span> <span class="hl com"> */</span> <span class="hl kwb">void</span> <span class="hl kwc">DeviceMatch</span><span class="hl opt">::</span><span class="hl kwd">add</span><span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl opt">&</span>entity<span class="hl opt">)</span> <span class="hl opt">{</span> entities_<span class="hl opt">.</span><span class="hl kwd">push_back</span><span class="hl opt">(</span>entity<span class="hl opt">);</span> <span class="hl opt">}</span> <span class="hl com">/**</span> <span class="hl com"> * \brief Compare a search pattern with a media device</span> <span class="hl com"> * \param[in] device The media device</span> <span class="hl com"> *</span> <span class="hl com"> * Matching is performed on the Linux device driver name and entity names from</span> <span class="hl com"> * the media graph. A match is found if both the driver name matches and the</span> <span class="hl com"> * media device contains all the entities listed in the search pattern.</span> <span class="hl com"> *</span> <span class="hl com"> * \return true if the media device matches the search pattern, false otherwise