test_config.py 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136
  1. import unittest
  2. import numpy as np
  3. from pydantic import ValidationError
  4. from frigate.config import (
  5. FrigateConfig,
  6. DetectorTypeEnum,
  7. )
  8. class TestConfig(unittest.TestCase):
  9. def setUp(self):
  10. self.minimal = {
  11. "mqtt": {"host": "mqtt"},
  12. "cameras": {
  13. "back": {
  14. "ffmpeg": {
  15. "inputs": [
  16. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  17. ]
  18. },
  19. "detect": {
  20. "height": 1080,
  21. "width": 1920,
  22. "fps": 5,
  23. },
  24. }
  25. },
  26. }
  27. def test_config_class(self):
  28. frigate_config = FrigateConfig(**self.minimal)
  29. assert self.minimal == frigate_config.dict(exclude_unset=True)
  30. runtime_config = frigate_config.runtime_config
  31. assert "cpu" in runtime_config.detectors.keys()
  32. assert runtime_config.detectors["cpu"].type == DetectorTypeEnum.cpu
  33. def test_invalid_mqtt_config(self):
  34. config = {
  35. "mqtt": {"host": "mqtt", "user": "test"},
  36. "cameras": {
  37. "back": {
  38. "ffmpeg": {
  39. "inputs": [
  40. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  41. ]
  42. },
  43. "detect": {
  44. "height": 1080,
  45. "width": 1920,
  46. "fps": 5,
  47. },
  48. }
  49. },
  50. }
  51. self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
  52. def test_inherit_tracked_objects(self):
  53. config = {
  54. "mqtt": {"host": "mqtt"},
  55. "objects": {"track": ["person", "dog"]},
  56. "cameras": {
  57. "back": {
  58. "ffmpeg": {
  59. "inputs": [
  60. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  61. ]
  62. },
  63. "detect": {
  64. "height": 1080,
  65. "width": 1920,
  66. "fps": 5,
  67. },
  68. }
  69. },
  70. }
  71. frigate_config = FrigateConfig(**config)
  72. assert config == frigate_config.dict(exclude_unset=True)
  73. runtime_config = frigate_config.runtime_config
  74. assert "dog" in runtime_config.cameras["back"].objects.track
  75. def test_override_tracked_objects(self):
  76. config = {
  77. "mqtt": {"host": "mqtt"},
  78. "objects": {"track": ["person", "dog"]},
  79. "cameras": {
  80. "back": {
  81. "ffmpeg": {
  82. "inputs": [
  83. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  84. ]
  85. },
  86. "detect": {
  87. "height": 1080,
  88. "width": 1920,
  89. "fps": 5,
  90. },
  91. "objects": {"track": ["cat"]},
  92. }
  93. },
  94. }
  95. frigate_config = FrigateConfig(**config)
  96. assert config == frigate_config.dict(exclude_unset=True)
  97. runtime_config = frigate_config.runtime_config
  98. assert "cat" in runtime_config.cameras["back"].objects.track
  99. def test_default_object_filters(self):
  100. config = {
  101. "mqtt": {"host": "mqtt"},
  102. "objects": {"track": ["person", "dog"]},
  103. "cameras": {
  104. "back": {
  105. "ffmpeg": {
  106. "inputs": [
  107. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  108. ]
  109. },
  110. "detect": {
  111. "height": 1080,
  112. "width": 1920,
  113. "fps": 5,
  114. },
  115. }
  116. },
  117. }
  118. frigate_config = FrigateConfig(**config)
  119. assert config == frigate_config.dict(exclude_unset=True)
  120. runtime_config = frigate_config.runtime_config
  121. assert "dog" in runtime_config.cameras["back"].objects.filters
  122. def test_inherit_object_filters(self):
  123. config = {
  124. "mqtt": {"host": "mqtt"},
  125. "objects": {
  126. "track": ["person", "dog"],
  127. "filters": {"dog": {"threshold": 0.7}},
  128. },
  129. "cameras": {
  130. "back": {
  131. "ffmpeg": {
  132. "inputs": [
  133. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  134. ]
  135. },
  136. "detect": {
  137. "height": 1080,
  138. "width": 1920,
  139. "fps": 5,
  140. },
  141. }
  142. },
  143. }
  144. frigate_config = FrigateConfig(**config)
  145. assert config == frigate_config.dict(exclude_unset=True)
  146. runtime_config = frigate_config.runtime_config
  147. assert "dog" in runtime_config.cameras["back"].objects.filters
  148. assert runtime_config.cameras["back"].objects.filters["dog"].threshold == 0.7
  149. def test_override_object_filters(self):
  150. config = {
  151. "mqtt": {"host": "mqtt"},
  152. "cameras": {
  153. "back": {
  154. "ffmpeg": {
  155. "inputs": [
  156. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  157. ]
  158. },
  159. "detect": {
  160. "height": 1080,
  161. "width": 1920,
  162. "fps": 5,
  163. },
  164. "objects": {
  165. "track": ["person", "dog"],
  166. "filters": {"dog": {"threshold": 0.7}},
  167. },
  168. }
  169. },
  170. }
  171. frigate_config = FrigateConfig(**config)
  172. assert config == frigate_config.dict(exclude_unset=True)
  173. runtime_config = frigate_config.runtime_config
  174. assert "dog" in runtime_config.cameras["back"].objects.filters
  175. assert runtime_config.cameras["back"].objects.filters["dog"].threshold == 0.7
  176. def test_global_object_mask(self):
  177. config = {
  178. "mqtt": {"host": "mqtt"},
  179. "objects": {"track": ["person", "dog"]},
  180. "cameras": {
  181. "back": {
  182. "ffmpeg": {
  183. "inputs": [
  184. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  185. ]
  186. },
  187. "detect": {
  188. "height": 1080,
  189. "width": 1920,
  190. "fps": 5,
  191. },
  192. "objects": {
  193. "mask": "0,0,1,1,0,1",
  194. "filters": {"dog": {"mask": "1,1,1,1,1,1"}},
  195. },
  196. }
  197. },
  198. }
  199. frigate_config = FrigateConfig(**config)
  200. assert config == frigate_config.dict(exclude_unset=True)
  201. runtime_config = frigate_config.runtime_config
  202. back_camera = runtime_config.cameras["back"]
  203. assert "dog" in back_camera.objects.filters
  204. assert len(back_camera.objects.filters["dog"].raw_mask) == 2
  205. assert len(back_camera.objects.filters["person"].raw_mask) == 1
  206. def test_default_input_args(self):
  207. config = {
  208. "mqtt": {"host": "mqtt"},
  209. "cameras": {
  210. "back": {
  211. "ffmpeg": {
  212. "inputs": [
  213. {
  214. "path": "rtsp://10.0.0.1:554/video",
  215. "roles": ["detect"],
  216. },
  217. ]
  218. },
  219. "detect": {
  220. "height": 1080,
  221. "width": 1920,
  222. "fps": 5,
  223. },
  224. }
  225. },
  226. }
  227. frigate_config = FrigateConfig(**config)
  228. assert config == frigate_config.dict(exclude_unset=True)
  229. runtime_config = frigate_config.runtime_config
  230. assert "-rtsp_transport" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  231. def test_ffmpeg_params_global(self):
  232. config = {
  233. "ffmpeg": {"input_args": "-re"},
  234. "mqtt": {"host": "mqtt"},
  235. "cameras": {
  236. "back": {
  237. "ffmpeg": {
  238. "inputs": [
  239. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  240. ]
  241. },
  242. "detect": {
  243. "height": 1080,
  244. "width": 1920,
  245. "fps": 5,
  246. },
  247. "objects": {
  248. "track": ["person", "dog"],
  249. "filters": {"dog": {"threshold": 0.7}},
  250. },
  251. }
  252. },
  253. }
  254. frigate_config = FrigateConfig(**config)
  255. assert config == frigate_config.dict(exclude_unset=True)
  256. runtime_config = frigate_config.runtime_config
  257. assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  258. def test_ffmpeg_params_camera(self):
  259. config = {
  260. "mqtt": {"host": "mqtt"},
  261. "ffmpeg": {"input_args": ["test"]},
  262. "cameras": {
  263. "back": {
  264. "ffmpeg": {
  265. "inputs": [
  266. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  267. ],
  268. "input_args": ["-re"],
  269. },
  270. "detect": {
  271. "height": 1080,
  272. "width": 1920,
  273. "fps": 5,
  274. },
  275. "objects": {
  276. "track": ["person", "dog"],
  277. "filters": {"dog": {"threshold": 0.7}},
  278. },
  279. }
  280. },
  281. }
  282. frigate_config = FrigateConfig(**config)
  283. assert config == frigate_config.dict(exclude_unset=True)
  284. runtime_config = frigate_config.runtime_config
  285. assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  286. assert "test" not in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  287. def test_ffmpeg_params_input(self):
  288. config = {
  289. "mqtt": {"host": "mqtt"},
  290. "ffmpeg": {"input_args": ["test2"]},
  291. "cameras": {
  292. "back": {
  293. "ffmpeg": {
  294. "inputs": [
  295. {
  296. "path": "rtsp://10.0.0.1:554/video",
  297. "roles": ["detect"],
  298. "input_args": "-re test",
  299. }
  300. ],
  301. "input_args": "test3",
  302. },
  303. "detect": {
  304. "height": 1080,
  305. "width": 1920,
  306. "fps": 5,
  307. },
  308. "objects": {
  309. "track": ["person", "dog"],
  310. "filters": {"dog": {"threshold": 0.7}},
  311. },
  312. }
  313. },
  314. }
  315. frigate_config = FrigateConfig(**config)
  316. assert config == frigate_config.dict(exclude_unset=True)
  317. runtime_config = frigate_config.runtime_config
  318. assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  319. assert "test" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  320. assert "test2" not in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  321. assert "test3" not in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
  322. def test_inherit_clips_retention(self):
  323. config = {
  324. "mqtt": {"host": "mqtt"},
  325. "record": {
  326. "events": {"retain": {"default": 20, "objects": {"person": 30}}}
  327. },
  328. "cameras": {
  329. "back": {
  330. "ffmpeg": {
  331. "inputs": [
  332. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  333. ]
  334. },
  335. "detect": {
  336. "height": 1080,
  337. "width": 1920,
  338. "fps": 5,
  339. },
  340. }
  341. },
  342. }
  343. frigate_config = FrigateConfig(**config)
  344. assert config == frigate_config.dict(exclude_unset=True)
  345. runtime_config = frigate_config.runtime_config
  346. assert (
  347. runtime_config.cameras["back"].record.events.retain.objects["person"] == 30
  348. )
  349. def test_roles_listed_twice_throws_error(self):
  350. config = {
  351. "mqtt": {"host": "mqtt"},
  352. "record": {
  353. "events": {"retain": {"default": 20, "objects": {"person": 30}}}
  354. },
  355. "cameras": {
  356. "back": {
  357. "ffmpeg": {
  358. "inputs": [
  359. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]},
  360. {"path": "rtsp://10.0.0.1:554/video2", "roles": ["detect"]},
  361. ]
  362. },
  363. "detect": {
  364. "height": 1080,
  365. "width": 1920,
  366. "fps": 5,
  367. },
  368. }
  369. },
  370. }
  371. self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
  372. def test_zone_matching_camera_name_throws_error(self):
  373. config = {
  374. "mqtt": {"host": "mqtt"},
  375. "record": {
  376. "events": {"retain": {"default": 20, "objects": {"person": 30}}}
  377. },
  378. "cameras": {
  379. "back": {
  380. "ffmpeg": {
  381. "inputs": [
  382. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  383. ]
  384. },
  385. "detect": {
  386. "height": 1080,
  387. "width": 1920,
  388. "fps": 5,
  389. },
  390. "zones": {"back": {"coordinates": "1,1,1,1,1,1"}},
  391. }
  392. },
  393. }
  394. self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
  395. def test_zone_assigns_color_and_contour(self):
  396. config = {
  397. "mqtt": {"host": "mqtt"},
  398. "record": {
  399. "events": {"retain": {"default": 20, "objects": {"person": 30}}}
  400. },
  401. "cameras": {
  402. "back": {
  403. "ffmpeg": {
  404. "inputs": [
  405. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  406. ]
  407. },
  408. "detect": {
  409. "height": 1080,
  410. "width": 1920,
  411. "fps": 5,
  412. },
  413. "zones": {"test": {"coordinates": "1,1,1,1,1,1"}},
  414. }
  415. },
  416. }
  417. frigate_config = FrigateConfig(**config)
  418. assert config == frigate_config.dict(exclude_unset=True)
  419. runtime_config = frigate_config.runtime_config
  420. assert isinstance(
  421. runtime_config.cameras["back"].zones["test"].contour, np.ndarray
  422. )
  423. assert runtime_config.cameras["back"].zones["test"].color != (0, 0, 0)
  424. def test_clips_should_default_to_global_objects(self):
  425. config = {
  426. "mqtt": {"host": "mqtt"},
  427. "record": {
  428. "events": {"retain": {"default": 20, "objects": {"person": 30}}}
  429. },
  430. "objects": {"track": ["person", "dog"]},
  431. "cameras": {
  432. "back": {
  433. "ffmpeg": {
  434. "inputs": [
  435. {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
  436. ]
  437. },
  438. "detect": {
  439. "height": 1080,
  440. "width": 1920,
  441. "fps": 5,
  442. },
  443. "record": {"events": {}},
  444. }
  445. },
  446. }
  447. frigate_config = FrigateConfig(**config)
  448. assert config == frigate_config.dict(exclude_unset=True)
  449. runtime_config = frigate_config.runtime_config
  450. back_camera = runtime_config.cameras["back"]
  451. assert back_camera.record.events.objects is None
  452. assert back_camera.record.events.retain.objects["person"] == 30
  453. def test_role_assigned_but_not_enabled(self):
  454. config = {
  455. "mqtt": {"host": "mqtt"},
  456. "cameras": {
  457. "back": {
  458. "ffmpeg": {
  459. "inputs": [
  460. {
  461. "path": "rtsp://10.0.0.1:554/video",
  462. "roles": ["detect", "rtmp"],
  463. },
  464. {"path": "rtsp://10.0.0.1:554/record", "roles": ["record"]},
  465. ]
  466. },
  467. "detect": {
  468. "height": 1080,
  469. "width": 1920,
  470. "fps": 5,
  471. },
  472. }
  473. },
  474. }
  475. frigate_config = FrigateConfig(**config)
  476. assert config == frigate_config.dict(exclude_unset=True)
  477. runtime_config = frigate_config.runtime_config
  478. ffmpeg_cmds = runtime_config.cameras["back"].ffmpeg_cmds
  479. assert len(ffmpeg_cmds) == 1
  480. assert not "clips" in ffmpeg_cmds[0]["roles"]
  481. def test_max_disappeared_default(self):
  482. config = {
  483. "mqtt": {"host": "mqtt"},
  484. "cameras": {
  485. "back": {
  486. "ffmpeg": {
  487. "inputs": [
  488. {
  489. "path": "rtsp://10.0.0.1:554/video",
  490. "roles": ["detect"],
  491. },
  492. ]
  493. },
  494. "detect": {
  495. "enabled": True,
  496. "height": 1080,
  497. "width": 1920,
  498. "fps": 5,
  499. },
  500. }
  501. },
  502. }
  503. frigate_config = FrigateConfig(**config)
  504. assert config == frigate_config.dict(exclude_unset=True)
  505. runtime_config = frigate_config.runtime_config
  506. assert runtime_config.cameras["back"].detect.max_disappeared == 5 * 5
  507. def test_motion_frame_height_wont_go_below_120(self):
  508. config = {
  509. "mqtt": {"host": "mqtt"},
  510. "cameras": {
  511. "back": {
  512. "ffmpeg": {
  513. "inputs": [
  514. {
  515. "path": "rtsp://10.0.0.1:554/video",
  516. "roles": ["detect"],
  517. },
  518. ]
  519. },
  520. "detect": {
  521. "height": 1080,
  522. "width": 1920,
  523. "fps": 5,
  524. },
  525. }
  526. },
  527. }
  528. frigate_config = FrigateConfig(**config)
  529. assert config == frigate_config.dict(exclude_unset=True)
  530. runtime_config = frigate_config.runtime_config
  531. assert runtime_config.cameras["back"].motion.frame_height >= 120
  532. def test_motion_contour_area_dynamic(self):
  533. config = {
  534. "mqtt": {"host": "mqtt"},
  535. "cameras": {
  536. "back": {
  537. "ffmpeg": {
  538. "inputs": [
  539. {
  540. "path": "rtsp://10.0.0.1:554/video",
  541. "roles": ["detect"],
  542. },
  543. ]
  544. },
  545. "detect": {
  546. "height": 1080,
  547. "width": 1920,
  548. "fps": 5,
  549. },
  550. }
  551. },
  552. }
  553. frigate_config = FrigateConfig(**config)
  554. assert config == frigate_config.dict(exclude_unset=True)
  555. runtime_config = frigate_config.runtime_config
  556. assert round(runtime_config.cameras["back"].motion.contour_area) == 99
  557. def test_merge_labelmap(self):
  558. config = {
  559. "mqtt": {"host": "mqtt"},
  560. "model": {"labelmap": {7: "truck"}},
  561. "cameras": {
  562. "back": {
  563. "ffmpeg": {
  564. "inputs": [
  565. {
  566. "path": "rtsp://10.0.0.1:554/video",
  567. "roles": ["detect"],
  568. },
  569. ]
  570. },
  571. "detect": {
  572. "height": 1080,
  573. "width": 1920,
  574. "fps": 5,
  575. },
  576. }
  577. },
  578. }
  579. frigate_config = FrigateConfig(**config)
  580. assert config == frigate_config.dict(exclude_unset=True)
  581. runtime_config = frigate_config.runtime_config
  582. assert runtime_config.model.merged_labelmap[7] == "truck"
  583. def test_default_labelmap_empty(self):
  584. config = {
  585. "mqtt": {"host": "mqtt"},
  586. "cameras": {
  587. "back": {
  588. "ffmpeg": {
  589. "inputs": [
  590. {
  591. "path": "rtsp://10.0.0.1:554/video",
  592. "roles": ["detect"],
  593. },
  594. ]
  595. },
  596. "detect": {
  597. "height": 1080,
  598. "width": 1920,
  599. "fps": 5,
  600. },
  601. }
  602. },
  603. }
  604. frigate_config = FrigateConfig(**config)
  605. assert config == frigate_config.dict(exclude_unset=True)
  606. runtime_config = frigate_config.runtime_config
  607. assert runtime_config.model.merged_labelmap[0] == "person"
  608. def test_default_labelmap(self):
  609. config = {
  610. "mqtt": {"host": "mqtt"},
  611. "model": {"width": 320, "height": 320},
  612. "cameras": {
  613. "back": {
  614. "ffmpeg": {
  615. "inputs": [
  616. {
  617. "path": "rtsp://10.0.0.1:554/video",
  618. "roles": ["detect"],
  619. },
  620. ]
  621. },
  622. "detect": {
  623. "height": 1080,
  624. "width": 1920,
  625. "fps": 5,
  626. },
  627. }
  628. },
  629. }
  630. frigate_config = FrigateConfig(**config)
  631. assert config == frigate_config.dict(exclude_unset=True)
  632. runtime_config = frigate_config.runtime_config
  633. assert runtime_config.model.merged_labelmap[0] == "person"
  634. def test_fails_on_invalid_role(self):
  635. config = {
  636. "mqtt": {"host": "mqtt"},
  637. "cameras": {
  638. "back": {
  639. "ffmpeg": {
  640. "inputs": [
  641. {
  642. "path": "rtsp://10.0.0.1:554/video",
  643. "roles": ["detect", "clips"],
  644. },
  645. ]
  646. },
  647. "detect": {
  648. "height": 1080,
  649. "width": 1920,
  650. "fps": 5,
  651. },
  652. }
  653. },
  654. }
  655. self.assertRaises(ValidationError, lambda: FrigateConfig(**config))
  656. def test_global_detect(self):
  657. config = {
  658. "mqtt": {"host": "mqtt"},
  659. "detect": {"max_disappeared": 1},
  660. "cameras": {
  661. "back": {
  662. "ffmpeg": {
  663. "inputs": [
  664. {
  665. "path": "rtsp://10.0.0.1:554/video",
  666. "roles": ["detect"],
  667. },
  668. ]
  669. },
  670. "detect": {
  671. "height": 1080,
  672. "width": 1920,
  673. "fps": 5,
  674. },
  675. }
  676. },
  677. }
  678. frigate_config = FrigateConfig(**config)
  679. assert config == frigate_config.dict(exclude_unset=True)
  680. runtime_config = frigate_config.runtime_config
  681. assert runtime_config.cameras["back"].detect.max_disappeared == 1
  682. assert runtime_config.cameras["back"].detect.height == 1080
  683. def test_default_detect(self):
  684. config = {
  685. "mqtt": {"host": "mqtt"},
  686. "cameras": {
  687. "back": {
  688. "ffmpeg": {
  689. "inputs": [
  690. {
  691. "path": "rtsp://10.0.0.1:554/video",
  692. "roles": ["detect"],
  693. },
  694. ]
  695. }
  696. }
  697. },
  698. }
  699. frigate_config = FrigateConfig(**config)
  700. assert config == frigate_config.dict(exclude_unset=True)
  701. runtime_config = frigate_config.runtime_config
  702. assert runtime_config.cameras["back"].detect.max_disappeared == 25
  703. assert runtime_config.cameras["back"].detect.height == 720
  704. def test_global_detect_merge(self):
  705. config = {
  706. "mqtt": {"host": "mqtt"},
  707. "detect": {"max_disappeared": 1, "height": 720},
  708. "cameras": {
  709. "back": {
  710. "ffmpeg": {
  711. "inputs": [
  712. {
  713. "path": "rtsp://10.0.0.1:554/video",
  714. "roles": ["detect"],
  715. },
  716. ]
  717. },
  718. "detect": {
  719. "height": 1080,
  720. "width": 1920,
  721. "fps": 5,
  722. },
  723. }
  724. },
  725. }
  726. frigate_config = FrigateConfig(**config)
  727. assert config == frigate_config.dict(exclude_unset=True)
  728. runtime_config = frigate_config.runtime_config
  729. assert runtime_config.cameras["back"].detect.max_disappeared == 1
  730. assert runtime_config.cameras["back"].detect.height == 1080
  731. assert runtime_config.cameras["back"].detect.width == 1920
  732. def test_global_snapshots(self):
  733. config = {
  734. "mqtt": {"host": "mqtt"},
  735. "snapshots": {"enabled": True},
  736. "cameras": {
  737. "back": {
  738. "ffmpeg": {
  739. "inputs": [
  740. {
  741. "path": "rtsp://10.0.0.1:554/video",
  742. "roles": ["detect"],
  743. },
  744. ]
  745. },
  746. "snapshots": {
  747. "height": 100,
  748. },
  749. }
  750. },
  751. }
  752. frigate_config = FrigateConfig(**config)
  753. assert config == frigate_config.dict(exclude_unset=True)
  754. runtime_config = frigate_config.runtime_config
  755. assert runtime_config.cameras["back"].snapshots.enabled
  756. assert runtime_config.cameras["back"].snapshots.height == 100
  757. def test_default_snapshots(self):
  758. config = {
  759. "mqtt": {"host": "mqtt"},
  760. "cameras": {
  761. "back": {
  762. "ffmpeg": {
  763. "inputs": [
  764. {
  765. "path": "rtsp://10.0.0.1:554/video",
  766. "roles": ["detect"],
  767. },
  768. ]
  769. }
  770. }
  771. },
  772. }
  773. frigate_config = FrigateConfig(**config)
  774. assert config == frigate_config.dict(exclude_unset=True)
  775. runtime_config = frigate_config.runtime_config
  776. assert runtime_config.cameras["back"].snapshots.bounding_box
  777. assert runtime_config.cameras["back"].snapshots.quality == 70
  778. def test_global_snapshots_merge(self):
  779. config = {
  780. "mqtt": {"host": "mqtt"},
  781. "snapshots": {"bounding_box": False, "height": 300},
  782. "cameras": {
  783. "back": {
  784. "ffmpeg": {
  785. "inputs": [
  786. {
  787. "path": "rtsp://10.0.0.1:554/video",
  788. "roles": ["detect"],
  789. },
  790. ]
  791. },
  792. "snapshots": {
  793. "height": 150,
  794. "enabled": True,
  795. },
  796. }
  797. },
  798. }
  799. frigate_config = FrigateConfig(**config)
  800. assert config == frigate_config.dict(exclude_unset=True)
  801. runtime_config = frigate_config.runtime_config
  802. assert runtime_config.cameras["back"].snapshots.bounding_box == False
  803. assert runtime_config.cameras["back"].snapshots.height == 150
  804. assert runtime_config.cameras["back"].snapshots.enabled
  805. def test_global_rtmp(self):
  806. config = {
  807. "mqtt": {"host": "mqtt"},
  808. "rtmp": {"enabled": True},
  809. "cameras": {
  810. "back": {
  811. "ffmpeg": {
  812. "inputs": [
  813. {
  814. "path": "rtsp://10.0.0.1:554/video",
  815. "roles": ["detect"],
  816. },
  817. ]
  818. },
  819. }
  820. },
  821. }
  822. frigate_config = FrigateConfig(**config)
  823. assert config == frigate_config.dict(exclude_unset=True)
  824. runtime_config = frigate_config.runtime_config
  825. assert runtime_config.cameras["back"].rtmp.enabled
  826. def test_default_rtmp(self):
  827. config = {
  828. "mqtt": {"host": "mqtt"},
  829. "cameras": {
  830. "back": {
  831. "ffmpeg": {
  832. "inputs": [
  833. {
  834. "path": "rtsp://10.0.0.1:554/video",
  835. "roles": ["detect"],
  836. },
  837. ]
  838. }
  839. }
  840. },
  841. }
  842. frigate_config = FrigateConfig(**config)
  843. assert config == frigate_config.dict(exclude_unset=True)
  844. runtime_config = frigate_config.runtime_config
  845. assert runtime_config.cameras["back"].rtmp.enabled
  846. def test_global_rtmp_merge(self):
  847. config = {
  848. "mqtt": {"host": "mqtt"},
  849. "rtmp": {"enabled": False},
  850. "cameras": {
  851. "back": {
  852. "ffmpeg": {
  853. "inputs": [
  854. {
  855. "path": "rtsp://10.0.0.1:554/video",
  856. "roles": ["detect"],
  857. },
  858. ]
  859. },
  860. "rtmp": {
  861. "enabled": True,
  862. },
  863. }
  864. },
  865. }
  866. frigate_config = FrigateConfig(**config)
  867. assert config == frigate_config.dict(exclude_unset=True)
  868. runtime_config = frigate_config.runtime_config
  869. assert runtime_config.cameras["back"].rtmp.enabled
  870. def test_global_live(self):
  871. config = {
  872. "mqtt": {"host": "mqtt"},
  873. "live": {"quality": 4},
  874. "cameras": {
  875. "back": {
  876. "ffmpeg": {
  877. "inputs": [
  878. {
  879. "path": "rtsp://10.0.0.1:554/video",
  880. "roles": ["detect"],
  881. },
  882. ]
  883. },
  884. }
  885. },
  886. }
  887. frigate_config = FrigateConfig(**config)
  888. assert config == frigate_config.dict(exclude_unset=True)
  889. runtime_config = frigate_config.runtime_config
  890. assert runtime_config.cameras["back"].live.quality == 4
  891. def test_default_live(self):
  892. config = {
  893. "mqtt": {"host": "mqtt"},
  894. "cameras": {
  895. "back": {
  896. "ffmpeg": {
  897. "inputs": [
  898. {
  899. "path": "rtsp://10.0.0.1:554/video",
  900. "roles": ["detect"],
  901. },
  902. ]
  903. }
  904. }
  905. },
  906. }
  907. frigate_config = FrigateConfig(**config)
  908. assert config == frigate_config.dict(exclude_unset=True)
  909. runtime_config = frigate_config.runtime_config
  910. assert runtime_config.cameras["back"].live.quality == 8
  911. def test_global_live_merge(self):
  912. config = {
  913. "mqtt": {"host": "mqtt"},
  914. "live": {"quality": 4, "height": 480},
  915. "cameras": {
  916. "back": {
  917. "ffmpeg": {
  918. "inputs": [
  919. {
  920. "path": "rtsp://10.0.0.1:554/video",
  921. "roles": ["detect"],
  922. },
  923. ]
  924. },
  925. "live": {
  926. "quality": 7,
  927. },
  928. }
  929. },
  930. }
  931. frigate_config = FrigateConfig(**config)
  932. assert config == frigate_config.dict(exclude_unset=True)
  933. runtime_config = frigate_config.runtime_config
  934. assert runtime_config.cameras["back"].live.quality == 7
  935. assert runtime_config.cameras["back"].live.height == 480
  936. def test_global_timestamp_style(self):
  937. config = {
  938. "mqtt": {"host": "mqtt"},
  939. "timestamp_style": {"position": "bl"},
  940. "cameras": {
  941. "back": {
  942. "ffmpeg": {
  943. "inputs": [
  944. {
  945. "path": "rtsp://10.0.0.1:554/video",
  946. "roles": ["detect"],
  947. },
  948. ]
  949. },
  950. }
  951. },
  952. }
  953. frigate_config = FrigateConfig(**config)
  954. assert config == frigate_config.dict(exclude_unset=True)
  955. runtime_config = frigate_config.runtime_config
  956. assert runtime_config.cameras["back"].timestamp_style.position == "bl"
  957. def test_default_timestamp_style(self):
  958. config = {
  959. "mqtt": {"host": "mqtt"},
  960. "cameras": {
  961. "back": {
  962. "ffmpeg": {
  963. "inputs": [
  964. {
  965. "path": "rtsp://10.0.0.1:554/video",
  966. "roles": ["detect"],
  967. },
  968. ]
  969. }
  970. }
  971. },
  972. }
  973. frigate_config = FrigateConfig(**config)
  974. assert config == frigate_config.dict(exclude_unset=True)
  975. runtime_config = frigate_config.runtime_config
  976. assert runtime_config.cameras["back"].timestamp_style.position == "tl"
  977. def test_global_timestamp_style_merge(self):
  978. config = {
  979. "mqtt": {"host": "mqtt"},
  980. "rtmp": {"enabled": False},
  981. "timestamp_style": {"position": "br", "thickness": 2},
  982. "cameras": {
  983. "back": {
  984. "ffmpeg": {
  985. "inputs": [
  986. {
  987. "path": "rtsp://10.0.0.1:554/video",
  988. "roles": ["detect"],
  989. },
  990. ]
  991. },
  992. "timestamp_style": {"position": "bl", "thickness": 4},
  993. }
  994. },
  995. }
  996. frigate_config = FrigateConfig(**config)
  997. assert config == frigate_config.dict(exclude_unset=True)
  998. runtime_config = frigate_config.runtime_config
  999. assert runtime_config.cameras["back"].timestamp_style.position == "bl"
  1000. assert runtime_config.cameras["back"].timestamp_style.thickness == 4
  1001. def test_allow_retain_to_be_a_decimal(self):
  1002. config = {
  1003. "mqtt": {"host": "mqtt"},
  1004. "snapshots": {"retain": {"default": 1.5}},
  1005. "cameras": {
  1006. "back": {
  1007. "ffmpeg": {
  1008. "inputs": [
  1009. {
  1010. "path": "rtsp://10.0.0.1:554/video",
  1011. "roles": ["detect"],
  1012. },
  1013. ]
  1014. },
  1015. }
  1016. },
  1017. }
  1018. frigate_config = FrigateConfig(**config)
  1019. assert config == frigate_config.dict(exclude_unset=True)
  1020. runtime_config = frigate_config.runtime_config
  1021. assert runtime_config.cameras["back"].snapshots.retain.default == 1.5
  1022. if __name__ == "__main__":
  1023. unittest.main(verbosity=2)