iPi Docs - User contributions [en]

Пользовательское соглашение рекордер

2026-05-26T12:40:28Z

== Лицензионное соглашение с конечным пользователем ==

'''iPi Recorder'''

Copyright © ООО «АйПай Софт». Все права защищены.

[[iPi Recorder]] является товарным знаком [https://ipisoft.ru ООО «АйПай Софт»].

[[iPi Recorder]] бесплатен для использования в любых условиях, включая, но не ограничиваясь: личное использование, академическое, коммерческое, государственное, бизнес, некоммерческое и коммерческое. «Бесплатно» в предыдущем предложении означает, что установка и использование iPi Recorder не требует никаких затрат или платы. Настоящим предоставляется разрешение, бесплатно, любому лицу, получающему копию данного программного обеспечения (далее «Программное обеспечение»), использовать Программное обеспечение без ограничений, включая права на использование, копирование, публикацию и распространение Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать то же самое.

Вы не можете изменять, адаптировать, сдавать в аренду, лизинг, одалживать, продавать или создавать производные работы на основе Программного обеспечения или любой его части.

Данное программное обеспечение использует или содержит части из библиотек с открытым исходным кодом:
* [http://directshownet.sourceforge.net DirectShowNET] © David Wohlferd, Eric Nowinski, Øystein Hansen, Ka-Wai Chan
* [https://github.com/fluentribbon/Fluent.Ribbon Fluent.Ribbon] © 2009-2017 Bastian Schmidt, Degtyarev Daniel, Rikker Serg
* [https://github.com/JamesNK/Newtonsoft.Json Json.NET] © 2007-2017 James Newton-King
* [https://github.com/stangelandcl/LZ4Sharp LZ4Sharp] © 2011 Clayton Stangeland
* [https://github.com/naudio/NAudio NAudio] © 2001-2014 Mark Heath
* [https://github.com/baSSiLL/SharpAvi SharpAvi] © 2013-2018 Vasili Maslov
* [https://github.com/sharpdx/SharpDX SharpDX], [https://github.com/sharpdx/Toolkit SharpDX Toolkit] © 2010-2014 Alexandre Mutel
* [https://code.google.com/p/winusbnet WinUSBNet] © 2010 Thomas Bleeker
* [https://github.com/Ruslan-B/FFmpeg.AutoGen FFmpeg.AutoGen] © 2015 Ruslan Balanukhin
* [http://www.fatcow.com/free-icons FatCow Icons] Copyright © 2009-2014 FatCow Web Hosting

Данное программное обеспечение использует библиотеки проекта [https://www.ffmpeg.org/legal.html FFmpeg] под лицензией LGPL v3. Copyright © 2000-2017 разработчики FFmpeg.

Данное программное обеспечение использует библиотеки проекта [https://github.com/OpenKinect/libfreenect2 libfreenect2] под лицензией APACHE 2.0. Copyright © 2014 отдельные [https://github.com/OpenKinect/libfreenect2/blob/master/CONTRIB участники] OpenKinect.

Вышеуказанное уведомление об авторских правах и настоящее разрешение должны быть включены во все копии Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЁННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ВЛАДЕЛЬЦЫ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ИНУЮ ОТВЕТСТВЕННОСТЬ, ВОЗНИКШИЕ В РЕЗУЛЬТАТЕ ДЕЙСТВИЙ ПО ДОГОВОРУ, ДЕЛИКТА ИЛИ ИНЫМ ОБРАЗОМ, СВЯЗАННЫХ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ЕГО ИСПОЛЬЗОВАНИЕМ.

Пользовательское соглашение

2026-05-26T12:29:06Z

Pavel: Created page with "== Лицензионное соглашение с конечным пользователем == Настоящее Лицензионное соглашение с кон..."

== Лицензионное соглашение с конечным пользователем ==

Настоящее Лицензионное соглашение с конечным пользователем (далее «Соглашение») является юридическим договором между вами, как физическим лицом или отдельным юридическим лицом, и компанией ООО «АйПай Софт» (далее «АйПай Софт»).

ВНИМАТЕЛЬНО ПРОЧИТАЙТЕ УСЛОВИЯ НАСТОЯЩЕГО СОГЛАШЕНИЯ ПЕРЕД ЗАГРУЗКОЙ ПРОПРИЕТАРНОГО ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ АйПай Софт (ДАЛЕЕ «ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ»), ПОЛУЧЕНИЕМ ЛИЦЕНЗИОННОГО КЛЮЧА К ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ.

Программное обеспечение охраняется авторским правом и предоставляется вам по лицензии в соответствии с настоящим Соглашением, а не продаётся вам. Загружая программное обеспечение, получая лицензионный ключ к программному обеспечению или используя программное обеспечение, вы подтверждаете, что прочитали настоящее Соглашение, понимаете его, принимаете и соглашаетесь соблюдать его условия. Если вы не желаете соблюдать условия настоящего Соглашения, вы должны нажать кнопку «Я не принимаю» ниже, прекратить процесс загрузки или установки и воздержаться от доступа к программному обеспечению или его использования. Настоящее Соглашение представляет собой полный договор между вами и АйПай Софт в отношении программного обеспечения и заменяет любые предыдущие предложения, заявления или договорённости, которые могли существовать между вами и АйПай Софт в отношении программного обеспечения.

Данное программное обеспечение содержит код Autodesk® FBX®, разработанный компанией Autodesk, Inc. Copyright 2016 Autodesk, Inc. Все права защищены. Такой код предоставляется «как есть», и Autodesk, Inc. отказывается от любых явных или подразумеваемых гарантий, включая, без ограничений, подразумеваемые гарантии товарной пригодности, пригодности для определённой цели или ненарушения прав третьих лиц. Ни при каких обстоятельствах Autodesk, Inc. не несёт ответственности за любые прямые, косвенные, случайные, особые, штрафные или косвенные убытки (включая, но не ограничиваясь, приобретение замещающих товаров или услуг; потерю использования, данных или прибыли; или прерывание деловой активности), возникшие в связи с использованием такого кода.

Данное программное обеспечение использует или содержит части из библиотек с открытым исходным кодом:
* [https://github.com/jstedfast/Ionic.Zlib Ionic.Zlib] Copyright © 2011 Jeffrey Stedfast
* [https://github.com/stangelandcl/LZ4Sharp LZ4Sharp] Copyright © 2011 Clayton Stangeland
* [https://github.com/naudio/NAudio NAudio] Copyright © 2008-2013 Mark Heath
* [https://github.com/objorke/oxyplot Oxy Plot] Copyright © 2012 Oystein Bjorke
* [https://github.com/baSSiLL/SharpAvi SharpAvi] Copyright © 2013-2018 Vasili Maslov
* [https://github.com/sharpdx/SharpDX SharpDX], [https://github.com/sharpdx/Toolkit SharpDX Toolkit] Copyright © 2010-2012 Alexandre Mutel
* [https://github.com/yadyn/WPF-Task-Dialog WPF Task Dialog Wrapper] Copyright © 2011-2012 Sean A. Hanley
* [http://www.fatcow.com/free-icons FatCow Icons] Copyright © 2009-2014 FatCow Web Hosting

=== 1. Лицензия ===

==== 1.1. Предоставление лицензии ====

АйПай Софт настоящим предоставляет вам, а вы принимаете ограниченную, неисключительную лицензию на использование программного обеспечения в машиночитаемой, объектной форме и руководств пользователя, сопровождающих программное обеспечение (далее «Документация»), только в порядке, разрешённом настоящим Соглашением. Для целей настоящего Соглашения «Программное обеспечение» включает любые обновления, улучшения, модификации, редакции или дополнения к программному обеспечению, сделанные АйПай Софт и предоставленные конечным пользователям через веб-сайт АйПай Софт. Несмотря на вышеизложенное, АйПай Софт не обязана предоставлять какие-либо обновления, улучшения, модификации, редакции или дополнения к программному обеспечению.

==== 1.2. Объём использования ====

Лицензия по подписке (аренда) ограничена по времени. Каждая лицензия по подписке имеет свой период подписки, начинающийся с даты первоначальной активации. Бессрочная лицензия не ограничена по времени. Для бессрочной лицензии обновления программного обеспечения предоставляются в течение предоплаченного периода в соответствии с условиями, опубликованными на веб-сайте АйПай Софт. Обновления бессрочной лицензии после истечения предоплаченного периода доступны по ежегодному плану продления поддержки. Вы можете использовать одну копию программного обеспечения, активированную лицензионным ключом, на одном компьютере (виртуальном или физическом), принадлежащем, арендованном или иным образом контролируемом вами, в один момент времени. Если у вас есть несколько лицензионных ключей на программное обеспечение, вы можете создавать и использовать столько копий программного обеспечения, сколько у вас есть лицензионных ключей. Дополнения к программному обеспечению требуют отдельного лицензионного ключа (далее «Лицензионный ключ дополнения»). Лицензионный ключ дополнения предоставляет доступ к дополнительным функциям и должен использоваться на машине с активированным лицензионным ключом на программное обеспечение. Для целей настоящего Соглашения «использование» программного обеспечения означает загрузку программного обеспечения в постоянную или временную память компьютера. Установка программного обеспечения на сетевой сервер исключительно для распространения на другие компьютеры не является «использованием» программного обеспечения и разрешена при условии, что у вас есть лицензионный ключ для каждого сервера (виртуального или физического), на который распространяется программное обеспечение. Программное обеспечение не может использоваться или распространяться на большее количество компьютеров, чем у вас есть лицензионных ключей. Если вы используете или распространяете программное обеспечение среди нескольких пользователей, вы должны обеспечить, чтобы количество пользователей не превышало количество полученных вами лицензионных ключей, в противном случае вы нарушите настоящее Соглашение.

==== 1.3. Копии и модификации ====

Вы не можете подвергать обратной инженерии, декомпилировать, дизассемблировать или иным образом транслировать программное обеспечение или любые полученные вами лицензионные ключи. Вы не можете каким-либо образом изменять или адаптировать программное обеспечение или любые полученные вами лицензионные ключи. Вы можете сделать одну копию программного обеспечения, документации и любых полученных вами лицензионных ключей исключительно для целей резервного копирования или архивирования. Любые такие копии программного обеспечения, документации или лицензионных ключей должны включать любые уведомления об авторских правах или других правах собственности, которые были включены в такие материалы при их первом получении. За исключением случаев, разрешённых в настоящем Разделе, никакие копии программного обеспечения, документации или лицензионных ключей, или любых их частей, не могут быть сделаны вами или любым лицом, находящимся под вашим руководством или контролем.

==== 1.4. Описание других прав и ограничений ====

* **Передача прав.** Вы не будете лицензировать, сублицензировать, продавать, перепродавать, передавать, уступать, распространять, сдавать в раздельное пользование или иным образом коммерчески использовать или делать программное обеспечение, документацию или лицензионные ключи доступными любой третьей стороне без предварительного письменного согласия АйПай Софт.
* **Аренда.** Вы не будете сдавать в аренду, прокат или одалживать свои права на программное обеспечение, документацию или лицензионные ключи, предоставленные настоящим Соглашением, любой третьей стороне без предварительного письменного согласия АйПай Софт.
* **Обслуживание.** Вы не будете действовать как сервисное бюро или бесплатный сервис по обработке с помощью программного обеспечения видеозаписей, предоставленных любой третьей стороной, без предварительного письменного согласия АйПай Софт. Это не налагает никаких ограничений на ваше право действовать как сервисное бюро или бесплатный сервис по созданию 3D-контента с помощью программного обеспечения, при условии, что вы не используете программное обеспечение для обработки видеозаписей, предоставленных какой-либо третьей стороной.
* **Образовательное использование.** Если программное обеспечение приобретено на условиях образовательной лицензионной программы АйПай Софт по образовательной скидке, лицензия ограничена использованием в образовательном контексте, либо для самообразования, либо для использования в образовательном учреждении в учебных целях. Вы не будете использовать образовательную лицензию в коммерческих, профессиональных или приносящих прибыль целях.
* **Пробная версия.** Пробная версия означает версию программного обеспечения для использования по ограниченной пробной лицензии только для ознакомления, демонстрации и оценки программного обеспечения в течение ограниченного периода времени в 30 дней. Вы не будете (i) устанавливать или использовать более одной копии пробной версии, (ii) изменять компьютерную систему для использования пробной версии в течение периода, превышающего 30 дней, (iii) использовать или распространять любой третьей стороне продукт, созданный с помощью пробной версии, в любых коммерческих целях и (iv) использовать пробную версию для какой-либо иной цели, кроме единственной цели определения целесообразности приобретения лицензии на коммерческую или образовательную версию программного обеспечения.

=== 2. Интеллектуальная собственность и конфиденциальность ===

==== 2.1. Отчётность об использовании, нарушения лицензии и средства правовой защиты ====

АйПай Софт оставляет за собой право собирать данные об использовании ключей, включая номера лицензионных ключей, модель процессора и материнской платы, модель и серийный номер жёсткого диска, MAC-адрес сетевого адаптера, SID пользователя ОС и другую информацию, считающуюся релевантной, чтобы обеспечить использование наших продуктов в соответствии с условиями настоящего Лицензионного соглашения с конечным пользователем. Любое несанкционированное использование будет рассматриваться АйПай Софт как нарушение настоящего Лицензионного соглашения. Вы соглашаетесь не блокировать, электронным или иным способом, передачу данных, необходимых для соблюдения настоящего соглашения. Любое блокирование данных, необходимых для соблюдения настоящего соглашения, считается нарушением настоящего соглашения и приведёт к немедленному расторжению настоящего Соглашения в соответствии с Разделом 4.

==== 2.2. Автоматическое обновление и истечение срока действия лицензии ====

Ваша лицензия может включать дату истечения срока действия, которая может привести к прекращению действия лицензии. Для бессрочных лицензионных ключей обновления программного обеспечения доступны в течение предоплаченного периода в соответствии с условиями, опубликованными на веб-сайте АйПай Софт, за исключением случаев, когда АйПай Софт определяет, что лицензия используется с нарушением условий настоящего Соглашения. Обновления бессрочной лицензии после истечения предоплаченного периода доступны по ежегодному плану продления поддержки. Если ваш лицензионный ключ украден или если вы подозреваете любое ненадлежащее или незаконное использование вашей лицензии вне вашего контроля, вы должны незамедлительно уведомить АйПай Софт о таком случае. Вам будет выдан заменяющий лицензионный ключ, а подозрительной лицензии будет позволено истечь. Для арендованных лицензий ваш платёж за последующий период должен быть произведён до даты истечения срока действия, чтобы обновления лицензии могли быть выполнены. Для вашего удобства АйПай Софт предоставляет предупреждения об истечении срока действия лицензии в интерфейсе продукта в случае возникновения каких-либо проблем, которые могут привести к истечению срока действия лицензии на продукт. Вы несёте ответственность за обращение в АйПай Софт по поводу любого потенциального истечения срока действия, которое вы считаете неуместным. АйПай Софт не несёт ответственности за любые убытки или затраты, понесённые в связи с истёкшими лицензиями.

==== 2.3. Права собственности на программное обеспечение и товарные знаки ====

Вы признаёте, что программное обеспечение и документация являются собственностью АйПай Софт, и что программное обеспечение и документация защищены законодательством США об авторском праве и международными договорами. Вы также признаёте и соглашаетесь, что, в отношениях между вами и АйПай Софт, АйПай Софт владеет и будет продолжать владеть всеми правами, правовыми титулами и интересами в отношении программного обеспечения и документации, включая связанные права интеллектуальной собственности по законам об авторском праве, коммерческой тайне, патентам или товарным знакам. Настоящее Соглашение не предоставляет вам никаких прав собственности на программное обеспечение или документацию, а только ограниченное право использования, которое может быть отозвано в соответствии с условиями настоящего Соглашения. Любые и все товарные знаки или знаки обслуживания, которые АйПай Софт использует в связи с программным обеспечением или услугами, предоставляемыми АйПай Софт, являются знаками, принадлежащими АйПай Софт. Настоящее Соглашение не предоставляет вам никаких прав, лицензий или интересов в отношении таких знаков, и вы не должны заявлять никаких прав, лицензий или интересов в отношении таких знаков или любых слов или дизайнов, сбивающих с толку похожих на такие знаки.

==== 2.4. Конфиденциальность ====

Вы должны разрешать использование программного обеспечения или просмотр документации только авторизованным пользователям, которые имеют законно полученные лицензионные ключи. За исключением случаев, прямо разрешённых настоящим Соглашением, вы не должны предоставлять программное обеспечение, документацию или любой лицензионный ключ любой третьей стороне. Вы будете использовать все возможные усилия для сотрудничества и помощи АйПай Софт в выявлении и предотвращении любого несанкционированного использования, копирования или раскрытия программного обеспечения, документации или любой их части.

=== 3. Лицензионные сборы ===

Программное обеспечение станет доступным для вашего использования после получения вами одного или нескольких лицензионных ключей. После принятия настоящего Соглашения вы можете получить один или несколько лицензионных ключей, оплатив необходимые лицензионные сборы, используя процедуру, изложенную на веб-сайте АйПай Софт. Лицензионные сборы, уплаченные вами, уплачиваются в качестве вознаграждения за лицензию, предоставленную по настоящему Соглашению. АйПай Софт не возвращает лицензионные сборы. Принимая настоящее Соглашение, вы полностью понимаете, что после того, как платёж лицензионного сбора будет произведён АйПай Софт, вы не будете иметь права на получение возврата какой-либо части сборов.

=== 4. Срок и расторжение ===

Настоящее Соглашение вступает в силу с момента вашего принятия Соглашения или с момента вашей загрузки, доступа и использования программного обеспечения, даже если вы прямо не приняли настоящее Соглашение. Настоящее Соглашение остаётся в силе до его расторжения. Без ущерба для любых других прав, настоящее Соглашение будет расторгнуто автоматически, если вы не соблюдаете какие-либо из ограничений или других требований, изложенных в настоящем документе. Если вы арендуете программное обеспечение и не оплачиваете применимые лицензионные сборы, АйПай Софт имеет право отключить вашу копию программного обеспечения. Вы можете расторгнуть настоящее Лицензионное соглашение в любое время, (i) направив письменное уведомление о вашем решении расторгнуть Соглашение в АйПай Софт и (ii) либо вернув АйПай Софт программное обеспечение, документацию, все их копии и все полученные вами лицензионные ключи, либо уничтожив все такие материалы и предоставив АйПай Софт письменное подтверждение такого уничтожения. АйПай Софт может расторгнуть настоящее Лицензионное соглашение, если вы нарушите какое-либо условие Соглашения, направив вам письменное уведомление о вашем нарушении и решении АйПай Софт расторгнуть Соглашение. После расторжения Соглашения АйПай Софт вы соглашаетесь либо вернуть АйПай Софт программное обеспечение, документацию, все их копии и все полученные вами лицензионные ключи, либо уничтожить все такие материалы и предоставить АйПай Софт письменное подтверждение такого уничтожения.

=== 5. Возмещение убытков ===

Вы обязуетесь за свой счёт возмещать и ограждать АйПай Софт, её дочерние и аффилированные компании, а также всех их должностных лиц, директоров и сотрудников от любых и всех претензий, исков, обязательств, убытков, судебных решений, грантов, издержек и расходов, включая разумные гонорары адвокатов (совместно именуемые «Претензии»), возникающих в результате любого использования программного обеспечения вами, любой связанной с вами стороной или любой стороной, действующей по вашему поручению, способом, прямо не разрешённым настоящим Соглашением.

=== 6. Отказ от гарантий ===

Программное обеспечение и документация предоставляются «как есть», и АйПай Софт отказывается от любых и всех других гарантий, явных или подразумеваемых, включая, без ограничений, любые подразумеваемые гарантии товарной пригодности или пригодности для определённой цели, в той мере, в какой это разрешено законом. Без ограничения вышеизложенного, АйПай Софт прямо не гарантирует, что программное обеспечение будет соответствовать вашим требованиям или что работа программного обеспечения будет бесперебойной или безошибочной. Вы принимаете на себя ответственность за выбор программного обеспечения для достижения ваших намеченных результатов и за результаты, полученные в результате использования вами программного обеспечения. Вы несёте полный риск в отношении качества и производительности программного обеспечения.

=== 7. Ограничение ответственности ===

Ни при каких обстоятельствах АйПай Софт не несёт ответственности перед вами или любой связанной с вами стороной за любые косвенные, случайные, consequential, особые, штрафные или иные косвенные убытки или упущенную выгоду, даже если АйПай Софт была уведомлена о возможности таких убытков.

=== 8. Общие положения ===

==== 8.1. Применимое право и выбор суда ====

Настоящее Соглашение регулируется и толкуется в соответствии с законами Российской Федерации, без учёта коллизионных норм. Любое требование или спор, возникающие в связи с настоящим Соглашением, подлежат разрешению в третейском суде в Москве, Российская Федерация. В максимальной степени, разрешённой законом, вы настоящим соглашаетесь на юрисдикцию и подсудность таких судов и отказываетесь от любых возражений против юрисдикции или подсудности таких судов.

==== 8.2. Неделимость ====

Если какой-либо термин или положение настоящего Соглашения будут признаны недействительными или не имеющими исковой силы в определённой ситуации любым судебным или административным органом, это заявление не влияет на действительность или исковую силу остающихся терминов и положений настоящего Соглашения или на действительность или исковую силу оспариваемого термина или положения в любой другой ситуации.

==== 8.3. Переживание ====

Статьи 2, 5, 6, 7 и 8 настоящего Соглашения и все их разделы сохраняют силу после расторжения настоящего Соглашения, независимо от причины расторжения, и остаются действительными и обязательными на неопределённый срок.

==== 8.4. Заголовки ====

Заголовки статей и разделов, содержащиеся в настоящем Соглашении, включены только для справочных целей и не влияют на значение или толкование настоящего Соглашения.

==== 8.5. Отказ от прав ====

Неспособность любой стороны обеспечить соблюдение любых прав, предоставленных настоящим Соглашением, или принять меры против другой стороны в случае любого нарушения настоящего Соглашения не считается отказом этой стороны от последующего обеспечения прав или последующих действий в случае будущих нарушений.

==== 8.6. Внесение изменений ====

АйПай Софт оставляет за собой право по своему усмотрению вносить изменения в настоящее Соглашение время от времени. В случае конфликта между настоящим Соглашением и наиболее актуальной версией настоящего Соглашения, размещённой по адресу www.ipisoft.ru, преимущественную силу имеет наиболее актуальная версия. Если вы не принимаете изменения, внесённые в настоящее Соглашение, то настоящая лицензия будет немедленно расторгнута в соответствии с Разделом 4.

==== 8.7. Налоги ====

Вы, в дополнение к лицензионным сборам, требуемым по настоящему Соглашению, уплачиваете все применимые налоги с продаж, пользования, передачи или другие налоги и все пошлины, будь то федеральные, региональные или местные, как бы они ни обозначались, которые взимаются или налагаются в связи с сделкой, предусмотренной настоящим Соглашением, за исключением налогов на доходы с чистой прибыли АйПай Софт. Вы возмещаете АйПай Софт сумму любых таких налогов или пошлин, уплаченных или понесённых непосредственно АйПай Софт в результате настоящей сделки.

Типы лицензий

2026-05-25T14:56:42Z

Pavel: Created page with "== Типы лицензий == === iPi Mocap Studio и дополнения === * iPi Mocap Studio и дополнения (Biomech, iPi Automati..."

== Типы лицензий ==
=== iPi Mocap Studio и дополнения ===
* [[iPi Mocap Studio]] и дополнения ([[iPi Biomech Add-on|Biomech]], [[iPi Automation Add-on|Automation]]) требуют лицензионный ключ.
* Мы предлагаем конфигурации [https://ipisoft.ru/software/express-edition/ Express], [https://ipisoft.ru/software/basic-edition/ Basic] и [https://ipisoft.ru/software/pro-edition/ Pro], которые отличаются функциями и ценой.
* Для использования дополнения вам необходимо активировать лицензионный ключ [[iPi Mocap Studio]] и лицензионный ключ дополнения.

==== Бессрочная лицензия ====
* Бессрочная лицензия (введена в версии 4) не ограничена по времени.
* Обновления программного обеспечения и техническая поддержка предоставляются без дополнительной оплаты в течение первых двух лет после активации бессрочного лицензионного ключа.
* Для продолжения получения обновлений программного обеспечения и технической поддержки по истечении двух лет после активации бессрочного лицензионного ключа необходимо оформить подписку на (опциональный) план технической поддержки.

==== Лицензия по подписке (аренда) ====
* Каждый лицензионный ключ подписки имеет период подписки, который начинается с даты первоначальной активации лицензионного ключа.
* Обновления программного обеспечения и техническая поддержка включены в планы подписки и предоставляются без дополнительной оплаты.

{{Note|Если ключ деактивирован, это не приостанавливает период подписки и не влияет на дату истечения срока действия ключа.}}

* После истечения срока действия лицензионного ключа вам необходимо активировать другой лицензионный ключ, чтобы продолжить использование программного обеспечения.

==== 30-дневная бесплатная пробная версия ====
* Для ознакомления доступна 30-дневная бесплатная пробная версия.
* Бесплатная пробная версия имеет все функции редакции Basic.
* После истечения 30-дневного пробного периода все функции остаются доступными, за исключением экспорта анимации и предпросмотра в реальном времени.

=== iPi Recorder ===
* [[iPi Recorder]] бесплатен и не требует лицензионного ключа.

{{Note|Экспорт видео в формат avi доступен, если на том же компьютере активирована лицензия [[iPi Mocap Studio]].}}

== Активация лицензии ==
* Мы используем онлайн-систему активации лицензий для [[iPi Mocap Studio]] и [[iPi Biomech Add-on]].
* Активация и деактивация лицензионных ключей осуществляется через пункт меню '''Справка > Управление лицензиями''' в [[iPi Mocap Studio]].
** Лицензия [[iPi Mocap Studio]] может быть активирована/деактивирована через пункт меню '''Справка > Управление лицензиями > Основная'''.
** Лицензия [[iPi Biomech Add-on]] может быть активирована/деактивирована через пункт меню '''Справка > Управление лицензиями > Biomech''' или нажатием кнопки '''Активировать''' на вкладке '''Biomech'''.
** Лицензия [[iPi Automation Add-on]] может быть активирована/деактивирована через пункт меню '''Справка > Управление лицензиями > Automation'''.
* После установки программного обеспечения система предложит вам активировать лицензионный ключ.
* Лицензионный ключ привязывается к компьютеру, на котором он был активирован. Система проверяет вашу аппаратную конфигурацию.
* Чтобы перенести лицензионный ключ на другой компьютер, пожалуйста, деактивируйте его на компьютере, которым вы сейчас пользуетесь, установите систему на новый компьютер и снова активируйте ключ.
* У нас также есть возможность офлайн-активации для тех, у кого нет активного подключения к Интернету.
* Если ваш компьютер вышел из строя и вы не можете деактивировать лицензию, пожалуйста, отправьте запрос на ручную деактивацию в нашу службу технической поддержки.

== Политика лицензирования iPi Mocap Studio и iPi Biomech Add-on ==
* Лицензия не может быть передана другому лицу или компании. Поэтому вы не должны передавать свой лицензионный ключ другу, коллеге или деловому партнёру.
* Одна лицензия не может быть активирована на нескольких компьютерах одновременно. Лицензия может быть перенесена на другой компьютер через процедуру [[#Активация лицензии|Деактивации/Активации]].

{{Note|Если вам нужно иметь систему на нескольких компьютерах, мы предлагаем [https://www.ipisoft.ru/store скидки за объём].}}

* Дополнения ([[iPi Biomech Add-on|Biomech]], [[iPi Automation Add-on|Automation]]) являются опциональными. Вы можете использовать [[iPi Mocap Studio]] без лицензии на дополнения.
* Дополнения требуют активированного лицензионного ключа [[iPi Mocap Studio]].
* Бесплатная пробная версия может быть использована только один раз и только на 30 дней. Установка системного времени на более раннюю дату или получение пробной лицензии на другой адрес электронной почты является нарушением условий лицензии.
* Мы оставляем за собой право заблокировать лицензионный ключ, если клиент нарушает условия лицензии.
* Подробные условия вы можете найти в [[iPi Studio EULA]] (Лицензионное соглашение с конечным пользователем), которое прилагается к программному обеспечению.

== Политика лицензирования iPi Recorder ==
* [[iPi Recorder]] — это бесплатное приложение, и вы можете запускать его на любом количестве компьютеров.
* Подробные условия вы можете найти в [[iPi Recorder EULA]] (Лицензионное соглашение с конечным пользователем), которое прилагается к программному обеспечению.

Streaming to Unreal

2025-11-25T10:54:58Z

Pavel:

{{EditionFeature|Basic}}

iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor and integrate reading animation stream from [[iPi Mocap Studio]] into your games or applications created with Unreal.

==Usage in Mocap Studio==

{{:Animation Streaming In Mocap Studio}}

==Usage in Unreal==

To get data streamed by [[iPi Mocap Studio]] into Unreal Engine please follow instructions below.

1. Install '''iPi Mocap Live Link''' plugin:

1.1. Download '''iPi Mocap Live Link''' plugin via links below.

Download:<br>UE 5.6 - [https://files.ipisoft.com/iPiMocap-Unreal-5-6.zip iPiMocap-Unreal-5-6.zip]; UE 5.5 - [https://files.ipisoft.com/iPiMocap-Unreal-5-5.zip iPiMocap-Unreal-5-5.zip]; UE 5.4 - [https://files.ipisoft.com/iPiMocap-Unreal-5-4.zip iPiMocap-Unreal-5-4.zip]; UE 5.3 - [https://files.ipisoft.com/iPiMocap-Unreal-5-3.zip iPiMocap-Unreal-5-3.zip]; UE 5.2 - [https://files.ipisoft.com/iPiMocap-Unreal-5-2.zip iPiMocap-Unreal-5-2.zip]; UE 5.1 - [https://files.ipisoft.com/iPiMocap-Unreal-5-1.zip iPiMocap-Unreal-5-1.zip]; UE 5.0 - [https://files.ipisoft.com/iPiMocap-Unreal-5-0.zip iPiMocap-Unreal-5-0.zip];<br>UE 4.27 - [https://files.ipisoft.com/iPiMocap-Unreal-4-27.zip iPiMocap-Unreal-4-27.zip]; UE 4.26 - [https://files.ipisoft.com/iPiMocap-Unreal-4-26.zip iPiMocap-Unreal-4-26.zip]; UE 4.25 - [https://files.ipisoft.com/iPiMocap-Unreal-4-25.zip iPiMocap-Unreal-4-25.zip]; UE 4.24 - [https://files.ipisoft.com/iPiMocap-Unreal-4-24.zip iPiMocap-Unreal-4-24.zip]

1.2. Unpack downloaded archieve into ''Engine\Plugins'' folder of your Unreal Engine installation. The folder ''iPiSoft'' will be created with subfolder ''iPiMocapLiveLink'' that will contain the plugin binaries and source code.

2. You will then have to activate installed plugin in your project.

2.1. (Re)start the Unreal Editor.

2.2. Open '''Plugins''' window via ''Edit > Plugins'' menu. Select ''Animation'' category.

2.3. Enable '''iPi Mocap Live Link''' and '''Live Link''' plugins.

2.4. Restart the editor by pressing '''Restart Now''' button.

[[File:UE-Enable-Plugin-Screen-1.png|center]]

3. Installed plugin will provide ''iPi Mocap Live Link'' source you can use to get animation data from '''iPi Mocap Studio'''. You can further use standard '''Live Link''' features to apply animation data to your character.

===Instuctions for quick test.===

====MetaHuman====
We used [https://www.unrealengine.com/marketplace/en-US/learn/metahumans MetaHumans] project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''MetaHuman'' rig.

[[File:UE-Start-Streaming-4.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate MetaHuman character. Feed in output of ''Live Link Pose'' into ''Control Rig'' component in ''m_med_nnw_animbp''. You can find it in ''Content > SampleMetaHumans > metahuman_004 > Male > Medium > NormalWeight > Body'' folder for male character or ''Content > SampleMetaHumans > metahuman_001 > Female > Medium > NormalWeight > Body'' for female character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-MetaHuman-Feed-In-Pose-Data.png|center|800px]]

====UE4 Mannequin (Standard Unreal Character)====
We used ''ThirdPerson'' project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''UE4 Mannequin'' rig if you use standard Unreal character. You can import your own rig into '''iPi Mocap Studio''' and setup motion transfer profile if you use custom rig.

[[File:UE-Start-Streaming-1.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate your character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-Animated.png|center|800px]]

Streaming to Unreal

2025-04-24T06:47:02Z

Pavel:

{{EditionFeature|Basic}}

iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor and integrate reading animation stream from [[iPi Mocap Studio]] into your games or applications created with Unreal.

==Usage in Mocap Studio==

{{:Animation Streaming In Mocap Studio}}

==Usage in Unreal==

To get data streamed by [[iPi Mocap Studio]] into Unreal Engine please follow instructions below.

1. Install '''iPi Mocap Live Link''' plugin:

1.1. Download '''iPi Mocap Live Link''' plugin via links below.

Download:<br>UE 5.5 - [https://files.ipisoft.com/iPiMocap-Unreal-5-5.zip iPiMocap-Unreal-5-5.zip]; UE 5.4 - [https://files.ipisoft.com/iPiMocap-Unreal-5-4.zip iPiMocap-Unreal-5-4.zip]; UE 5.3 - [https://files.ipisoft.com/iPiMocap-Unreal-5-3.zip iPiMocap-Unreal-5-3.zip]; UE 5.2 - [https://files.ipisoft.com/iPiMocap-Unreal-5-2.zip iPiMocap-Unreal-5-2.zip]; UE 5.1 - [https://files.ipisoft.com/iPiMocap-Unreal-5-1.zip iPiMocap-Unreal-5-1.zip]; UE 5.0 - [https://files.ipisoft.com/iPiMocap-Unreal-5-0.zip iPiMocap-Unreal-5-0.zip];<br>UE 4.27 - [https://files.ipisoft.com/iPiMocap-Unreal-4-27.zip iPiMocap-Unreal-4-27.zip]; UE 4.26 - [https://files.ipisoft.com/iPiMocap-Unreal-4-26.zip iPiMocap-Unreal-4-26.zip]; UE 4.25 - [https://files.ipisoft.com/iPiMocap-Unreal-4-25.zip iPiMocap-Unreal-4-25.zip]; UE 4.24 - [https://files.ipisoft.com/iPiMocap-Unreal-4-24.zip iPiMocap-Unreal-4-24.zip]

1.2. Unpack downloaded archieve into ''Engine\Plugins'' folder of your Unreal Engine installation. The folder ''iPiSoft'' will be created with subfolder ''iPiMocapLiveLink'' that will contain the plugin binaries and source code.

2. You will then have to activate installed plugin in your project.

2.1. (Re)start the Unreal Editor.

2.2. Open '''Plugins''' window via ''Edit > Plugins'' menu. Select ''Animation'' category.

2.3. Enable '''iPi Mocap Live Link''' and '''Live Link''' plugins.

2.4. Restart the editor by pressing '''Restart Now''' button.

[[File:UE-Enable-Plugin-Screen-1.png|center]]

3. Installed plugin will provide ''iPi Mocap Live Link'' source you can use to get animation data from '''iPi Mocap Studio'''. You can further use standard '''Live Link''' features to apply animation data to your character.

===Instuctions for quick test.===

====MetaHuman====
We used [https://www.unrealengine.com/marketplace/en-US/learn/metahumans MetaHumans] project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''MetaHuman'' rig.

[[File:UE-Start-Streaming-4.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate MetaHuman character. Feed in output of ''Live Link Pose'' into ''Control Rig'' component in ''m_med_nnw_animbp''. You can find it in ''Content > SampleMetaHumans > metahuman_004 > Male > Medium > NormalWeight > Body'' folder for male character or ''Content > SampleMetaHumans > metahuman_001 > Female > Medium > NormalWeight > Body'' for female character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-MetaHuman-Feed-In-Pose-Data.png|center|800px]]

====UE4 Mannequin (Standard Unreal Character)====
We used ''ThirdPerson'' project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''UE4 Mannequin'' rig if you use standard Unreal character. You can import your own rig into '''iPi Mocap Studio''' and setup motion transfer profile if you use custom rig.

[[File:UE-Start-Streaming-1.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate your character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-Animated.png|center|800px]]

iPi Mocap Studio Release Notes

2025-01-09T09:27:22Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.6.268|Jan 09, 2025|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.6.268.exe}}

 B U G    F I X E S:
* Rare crashes when applying AI tracking for RGB cameras in case of poor quality of input data.
 U N D E R    T H E    H O O D:
* Increased quality of [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|depth sensors calibration based on AI-detected joints]].
* Adjusted quality thresholds for [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|depth sensors calibration based on AI-detected joints]].

{{VersionShortInfo|4.6.5.267|Dec 26, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.5.267.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|Calibration for depth sensors based on AI-detected joints]] instead of flashlight or flat board. This substantially simplifies calibration process.
 B U G    F I X E S:
* Incorrect scale by person height after RGB calibration.
* ''Auto adjust camera FOV'' flag invalidated after calibration based on AI-detected joints.
 U N D E R    T H E    H O O D:
* Adjusted quality thresholds for calibration based on AI-detected joints.
* Added knee and elbow to the set of joints used for calibration.

{{VersionShortInfo|4.6.4.266|Oct 31, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.4.266.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration_Based_on_AI_Joints|Calibration for RGB cameras based on AI-detected joints]] instead of flashlight. This substantially simplifies calibration process.
* Full support for Orbbec Femto Bolt sensors
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
 U N D E R    T H E    H O O D:
* Improved quality of tracking that uses AI-detected pose as the initial guess.

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.265.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] feature added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
* Project recording with [[Real-time Tracking for Live Preview]] could not open.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

iPi Mocap Studio Release Notes

2025-01-09T09:26:53Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.6.268|Jan 09, 2025|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.6.268.exe}}

 B U G    F I X E S:
* Rare crashes when applying AI tracking for RGB cameras in case of poor quality input data.
 U N D E R    T H E    H O O D:
* Increased quality of [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|depth sensors calibration based on AI-detected joints]].
* Adjusted quality thresholds for [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|depth sensors calibration based on AI-detected joints]].

{{VersionShortInfo|4.6.5.267|Dec 26, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.5.267.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|Calibration for depth sensors based on AI-detected joints]] instead of flashlight or flat board. This substantially simplifies calibration process.
 B U G    F I X E S:
* Incorrect scale by person height after RGB calibration.
* ''Auto adjust camera FOV'' flag invalidated after calibration based on AI-detected joints.
 U N D E R    T H E    H O O D:
* Adjusted quality thresholds for calibration based on AI-detected joints.
* Added knee and elbow to the set of joints used for calibration.

{{VersionShortInfo|4.6.4.266|Oct 31, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.4.266.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration_Based_on_AI_Joints|Calibration for RGB cameras based on AI-detected joints]] instead of flashlight. This substantially simplifies calibration process.
* Full support for Orbbec Femto Bolt sensors
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
 U N D E R    T H E    H O O D:
* Improved quality of tracking that uses AI-detected pose as the initial guess.

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.265.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] feature added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
* Project recording with [[Real-time Tracking for Live Preview]] could not open.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

iPi Mocap Studio Release Notes

2024-12-25T18:31:29Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.5.267|Dec 26, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.5.267.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_Depth_Sensors_Configuration#Calibration_Based_on_AI_Joints|Calibration for depth sensors based on AI-detected joints]] instead of flashlight or flat board. This substantially simplifies calibration process.
 B U G    F I X E S:
* Incorrect scale by person height after RGB calibration.
* ''Auto adjust camera FOV'' flag invalidated after calibration based on AI-detected joints.
 U N D E R    T H E    H O O D:
* Adjusted quality thresholds for calibration based on AI-detected joints.
* Added knee and elbow to the set of joints used for calibration.

{{VersionShortInfo|4.6.4.266|Oct 31, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.4.266.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration_Based_on_AI_Joints|Calibration for RGB cameras based on AI-detected joints]] instead of flashlight. This substantially simplifies calibration process.
* Full support for Orbbec Femto Bolt sensors
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
 U N D E R    T H E    H O O D:
* Improved quality of tracking that uses AI-detected pose as the initial guess.

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.265.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] feature added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
* Project recording with [[Real-time Tracking for Live Preview]] could not open.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

File:Depth-Project-Scene-Tab-24.png

2024-12-24T19:33:11Z

Pavel:

User Guide for Multiple Depth Sensors Configuration

2024-12-24T19:26:47Z

Pavel: /* Step 3: Processing Calibration Video */

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Flashlight Calibration ===

==== Recording Calibration Video ====

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

===== Glowing Marker =====
{{:Glowing Marker}}

===== Step 1: Recording Calibration Sequence =====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

==== Step 2: Processing Calibration Video ====

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Kinect_Calibration_Flashlight_Completed.png|600px]]
|[[Image:Depth_Project_Scene_Tab.png|link=]]
|}
</center>

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

{{Note|Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Processing Calibration Video ====

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Use default calibration settings
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).
*:[[Image:Calibration-Depth-Project-Start-2.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Calibration-Depth-Project-Completed-2.png|600px]]
|[[Image:Depth-Project-Scene-Tab-24.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

File:Calibration-Depth-Project-Start-2.png

2024-12-24T19:19:04Z

Pavel:

User Guide for Multiple Depth Sensors Configuration

2024-12-24T19:18:29Z

Pavel: /* Calibration */

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Flashlight Calibration ===

==== Recording Calibration Video ====

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

===== Glowing Marker =====
{{:Glowing Marker}}

===== Step 1: Recording Calibration Sequence =====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

==== Step 2: Processing Calibration Video ====

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Kinect_Calibration_Flashlight_Completed.png|600px]]
|[[Image:Depth_Project_Scene_Tab.png|link=]]
|}
</center>

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

{{Note|Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Processing Calibration Video ====

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Use default calibration settings
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).
*:[[Image:Calibration-Depth-Project-Start-2.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Calibration-Depth-Project-Completed-2.png|600px]]
|[[Image:Depth_Project_Scene_Tab_24.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

User Guide for Multiple Depth Sensors Configuration

2024-12-24T18:48:33Z

Pavel:

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Recording Calibration Video ===

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

==== Glowing Marker ====
{{:Glowing Marker}}

==== Recording Calibration Sequence ====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

=== Processing Calibration Video ===

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Kinect_Calibration_Flashlight_Completed.png|600px]]
|[[Image:Depth_Project_Scene_Tab.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

User Guide for Multiple Depth Sensors Configuration

2024-12-24T18:44:09Z

Pavel: /* Processing Calibration Video */

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Recording Calibration Video ===

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

==== Glowing Marker ====
{{:Glowing Marker}}

==== Recording Calibration Sequence ====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

=== Processing Calibration Video ===

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Create-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Kinect_Calibration_Flashlight_Completed.png|600px]]
|[[Image:Depth_Project_Scene_Tab.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

File:Calibration-Depth-Project-Completed-2.png

2024-12-24T18:38:26Z

Pavel:

User Guide for Multiple Depth Sensors Configuration

2024-12-24T18:38:03Z

Pavel: /* Processing Calibration Video */

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Recording Calibration Video ===

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

==== Glowing Marker ====
{{:Glowing Marker}}

==== Recording Calibration Sequence ====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

=== Processing Calibration Video ===

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Create-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Calibration-Depth-Project-Start-2.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Calibration-Depth-Project-Completed-2.png|600px]]
|[[Image:Depth_Project_Scene_Tab_1.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

User Guide for Multiple Depth Sensors Configuration

2024-12-24T18:36:03Z

Pavel: /* Processing Calibration Video */

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Recording Calibration Video ===

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

==== Glowing Marker ====
{{:Glowing Marker}}

==== Recording Calibration Sequence ====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

=== Processing Calibration Video ===

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-2.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Calibration-Depth-Project-Completed-2.png|600px]]
|[[Image:Depth_Project_Scene_Tab_1.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

File:Depth Project Scene Tab.png

2024-12-24T18:28:45Z

Pavel: Pavel uploaded a new version of "File:Depth Project Scene Tab.png"

File:Depth Project Scene Tab.png

2024-12-24T18:28:04Z

Pavel: Pavel uploaded a new version of "File:Depth Project Scene Tab.png"

File:Depth Project Scene Tab.png

2024-12-24T18:27:14Z

Pavel: Pavel uploaded a new version of "File:Depth Project Scene Tab.png"

File:Depth Project Scene Tab.png

2024-12-24T18:26:21Z

Pavel: Pavel uploaded a new version of "File:Depth Project Scene Tab.png"

File:Calibration-Depth-Project-Start-1.png

2024-12-24T13:33:20Z

Pavel:

User Guide for Multiple Depth Sensors Configuration

2024-12-24T13:32:45Z

Pavel:

== System Requirements ==

===iPi Recorder===
{{:iPi Recorder System Requirements for Multiple Depth Sensors Configuration}}

===iPi Mocap Studio===

{{:iPi Mocap Studio System Requirements}}

{{Note|Before you start working with multiple depth sensors, it is highly recommended to get decent results with single depth sensor configuration: [[User Guide for Single Depth Sensor Configuration]]}}.

== Software Installation ==

{{:iPi Recorder Installation}}

{{:iPi Mocap Studio Installation}}

== Recording Video from Multiple Depth Sensors ==

{{:Recording Video from Depth Sensor Environment}}

Below in [[#Calibration]] section you will find information on 2 recommended sensors' mutual configuratioins.

{{:Actor Clothing Kinect}}

=== Recording Process ===

{{:iPi Recorder Description}}

Please run '''iPi Recorder''' and follow recording workflow as described in [[iPi_Recorder_User's_Guide#Recording_Workflow|user's guide]] for the program.

{{Tip|Have a look at a [[Video_Recording#Performance_Tips|list of recommendations]] to avoid hardware performance problems during recording.}}

== Calibration ==
{{:Calibration Definition}}

=== Dual Depth Sensors Configurations ===

There are two possible arrangements of the two sensors:
# angle between sensors is between 60 and 90 degrees;
# angle between sensors in near to 180 degrees that means that sensors are placed opposite to each other.

==== First configuration ====

<center>
{|
|[[Image:Kinect2-90-deg-setup.png|thumb|center|450px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-90-deg-setup.png|thumb|center|363px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-90-deg-setup.png|thumb|center|424px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>

==== Second configuration ====

<center>
{|
|[[Image:Kinect2-180-deg-setup.png|thumb|center|500px|Azure Kinect (NFOV mode)<br/>Kinect 2 (Kinect for Xbox One)]]
|[[Image:K4A-WFOV-180-deg-setup.png|thumb|center|457px|Azure Kinect (WFOV mode)<br/> ]]
|[[Image:Kinect1-180-deg-setup.png|thumb|center|440px|1st gen. depth sensors<br/>Orbbec Astra (Pro)]]
|}
</center>
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}

=== Triple Depth Sensors Configuration ===

Ideally, depth sensors should be placed at apexes of equilateral triangle with sides equal to about 6 meters.
<center>
{|
|[[Image:Triple-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|506px]]
|[[Image:Triple-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |506px]]
|[[Image:Triple-depth-sensor-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|500px]]
|}
</center>

In practice it may not always be achievable due to available space size and configuration, mount positions, USB and/or power cord lengths, etc. Thus, sensor positions may slightly differ from ideal ones. Please look at the example from real mocap session (1st gen. depth sensors).
<center>
{|
|[[Image:Triple-depth-sensor-scene-config.png|thumb|Real-life Scene Configuration Expample|500px]]
|}
</center>

=== Four Depth Sensors Configuration ===

Ideally, depth sensors should be placed at sides of a square, each pair of sensors facing each other.
{{Tip|If you see much noise (many yellow points) in any pair of sensors, try to slightly change direction of one of the sensors, this may substantially decrease noise caused by mutual interference. }}
<center>
{|
|[[Image:Four-kinect2-ideal-scene-config.png|thumb|Ideal Configuration for Kinect 2 (Kinect for Xbox One)<br/>and Azure Kinect (NFOV mode)|466px]]
|[[Image:Four-K4A-WFOV-ideal-scene-config.png|thumb|Ideal Configuration for Azure Kinect (WFOV mode)<br/> |466px]]
|[[Image:Four-kinect1-ideal-scene-config.png|thumb|Ideal Configuration for 1st gen. depth sensors<br/>and Orbbec Astra (Pro)|466px]]
|}
</center>

=== Recording Calibration Video ===

We use '''flashlight''' or other small glowing marker to perform calibration for depth sensors. This calibration procedure is very similar to one used for [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration|Multiple Sony PS Eye Cameras Configuration]]. But in case of depth sensors the overall workflow is simpler:
* There is no need to touch floor by flashlight during recording.
* No marking of points as ground in [[iPi Mocap Studio]].
*: (depth data is used to detect ground plane automatically)
* No manual adjustments of scene scale in [[iPi Mocap Studio]].
*: (depth data is used to determine scale automatically)

{{Note|For Dual Depth Sensor configuration you can use [http://wiki.ipisoft.com/User_Guide_for_Dual_Depth_Sensor_Configuration#Calibration calibration based on 3D plane]. Accuracy of both methods is the same. Using flashlight marker is recommended as more easy-to-use method.}}

==== Glowing Marker ====
{{:Glowing Marker}}

==== Recording Calibration Sequence ====

* Run [[iPi Recorder]].
* Color stream should be recorded along with depth data. That's why only modes "(depth+color)" can be used.
<center><table><tr><td>[[Image:IPi Recorder video mode.png|500px]]</td></tr></table></center>
* Avoid bright lightening and white objects on background during recording of calibration video.
* Start recording.
* Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|You should make the marker visible to both depth sensors at all times. Hold the marker in the straight arm away from your body.}}

=== Processing Calibration Video ===

* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (1)
** Choose '''Calibration project''' type in '''New Project Wizard'''.
*:[[Image:Calibration-Depth-Project-Start-1.png|center|600px]]
* Adjust [[Region-of-Interest]] so that glowing marker is visible at the beginning and at the end (2).
* Click '''Calibrate Based on Light Marker''' button (3).
*:[[Image:Kinect_Calibration_Flashlight_Start.png|center|600px]]
* Wait while automatic calibration is performing.
* Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result (5).
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking (5).}}
* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
<center>
{|
|[[Image:Kinect_Calibration_Flashlight_Completed.png|600px]]
|[[Image:Depth_Project_Scene_Tab.png|link=]]
|}
</center>

{{:Performance Kinect}}

== Processing Video from Multiple Depth Sensors ==
{{:Create Multicamera Action Project}}
{{:Processing Video from Depth Sensor}}

== Tracking Tips and Tricks ==

{{:Using Pose Mismatch View for Depth Sensors}}
{{:Checking Sensor Calibration for Depth Sensors}}

== Manual Clean-up ==

{{:Manual Clean-up}}

== Automatic Refinement and Filtering ==

{{:Automatic Refinement and Filtering}}

== Export and Motion Transfer ==

{{:Animation Export}}

== Video Materials ==

<center>{{#widget:YouTube|id=msRtIZX529Q|center|width=480|height=390}}</center>

* From Jimer Lins: Part 1 - Setting up your Kinects and Calibrating
<center>{{#widget:YouTube|id=VfBQNCqiM2M|center|width=480|height=390}}</center>

* From Jimer Lins: Part 2 - Recording the Action
<center>{{#widget:YouTube|id=7j2CKP6x-UA|center|width=480|height=390}}</center>

* From Jimer Lins: Part 3 - Processing the Recorded Action
<center>{{#widget:YouTube|id=cOeQOVy0bfM|center|width=480|height=390}}</center>

* From Jimer Lins: [http://www.youtube.com/playlist?list=PLD4409518E1F04270 see other parts]

Calibration Definition AI

2024-11-01T08:15:13Z

Pavel:

Novel AI-based pose estimation algorithms allow to use AI-detected joint positions instead of glowing object (flashlight), that makes the calibration workflow simpler.

{{Note|This feature requires Nvidia RTX video card. Please refer to detailed [[AI-based_Tracking#Introduction|System Requirements]]}}

{{Important|Once you calibrated the camera system, you should not move your cameras for subsequent video shoots. If you move at least one camera, you need to perform calibration again.}}

{{Tip|We recommend to run calibration twice - before and after capture session. If any camera was moved during capture session, calibration made after the session can give you correct camera positions.}}

Calibration Definition AI

2024-10-31T17:04:08Z

Pavel:

Calibration is a process of computing accurate camera positions and orientations from a video. This step is essential and required for multi-camera system setup.

Calibration can be done by user waving a small glowing object called ''marker'' (for color/color+depth cameras). Novel AI-based pose estimation algorithms allow to use AI-detected joint positions instead of glowing object (flashlight), that makes the process simpler.
{{Note|This feature requires Nvidia RTX video card. Please refer to detailed [[AI-based_Tracking#Introduction|System Requirements]]}}

{{Important|Once you calibrated the camera system, you should not move your cameras for subsequent video shoots. If you move at least one camera, you need to perform calibration again.}}

{{Tip|We recommend to run calibration twice - before and after capture session. If any camera was moved during capture session, calibration made after the session can give you correct camera positions.}}

iPi Mocap Studio Release Notes

2024-10-31T16:59:05Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.4.266|Oct 31, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.4.266.exe}}

 N E W    F E A T U R E S:
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Calibration_Based_on_AI_Joints|Calibration for RGB cameras based on AI-detected joints]] instead of flashlight. This substantially simplifies calibration process.
* Full support for Orbbec Femto Bolt sensors
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
 U N D E R    T H E    H O O D:
* Improved quality of tracking that uses AI-detected pose as the initial guess.

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.265.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] feature added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
* Project recording with [[Real-time Tracking for Live Preview]] could not open.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

File:Calibration Start Flashlight 1.png

2024-10-31T10:30:25Z

Pavel:

Multiple PS Eye Cameras Calibration

2024-10-31T10:30:07Z

Pavel:

=== Flashlight Calibration ===

{{:Calibration Definition}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start_Flashlight_1.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Change the size of light marker spot on video if needed.
** '''Medium''' usually work well, but you may need '''Large''' if you use Sony PS Move for calibration, or '''Small''' in some cases.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on Flashlight Marker''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 4: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start_AI_1.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).

==== Complete Calibration ====

Follow the same [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Step_6:_Check_Calibration_Quality|Steps 6-8]] described for flashlight calibration

Multiple PS Eye Cameras Calibration

2024-10-31T10:14:42Z

Pavel:

=== Flashlight Calibration ===

{{:Calibration Definition}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on Flashlight Marker''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 4: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start_AI_1.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).

==== Complete Calibration ====

Follow the same [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Step_6:_Check_Calibration_Quality|Steps 6-8]] described for flashlight calibration

File:Calibration Start AI 1.png

2024-10-31T10:07:35Z

Pavel:

Multiple PS Eye Cameras Calibration

2024-10-31T10:06:42Z

Pavel:

=== Flashlight Calibration ===

{{:Calibration Definition}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on Flashlight Marker''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 4: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start_AI_1.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

Multiple PS Eye Cameras Calibration

2024-10-31T09:37:47Z

Pavel:

=== Flashlight Calibration ===

{{:Calibration Definition}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on Flashlight Marker''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement cover the whole capture area. Videos when you stand at the same place all the time will not allow for accurate calibration. }}

{{Tip|For successful calibration, 1000 frames shoud be enough. Recording long videos over 1 minute length does not make much sense, but you still can use them for calibration. }}

==== Step 3: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 4: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras. If this screen is not shown, this means FOV is already known and you do not need to manually specify it.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you did not know camera field of view requested during project creation (if it was requested) or if it was set by default (this may be recommended for particular camera models).
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

Multiple PS Eye Cameras Calibration

2024-10-30T09:53:55Z

Pavel:

=== Flashlight Calibration ===

{{:Calibration Definition}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you do not use Sony PS3 Eye camera and do not know camera field of view
** '''Regular''' calibration mode
*** In rare cases when '''Regular''' mode fails to calibrate, you can use '''Extended''' and '''Extreme''' calibration modes. It will take much more time, but may help to calibrate correctly if you have high percent of marker misdetections. Usually this is caused by incorrect camera positioning or poor lighting conditions
* Click '''Calibrate Based on Flashlight Marker''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

=== Calibration Based on AI Joints ===

{{:Calibration Definition AI}}

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Step 1: Running [[iPi Recorder]] ====

Run [[iPi Recorder]] in a regular (default) mode used for recording action videos. Do not use darkening modes in "darkening for calibration" list (if available). Darkening is good for flashlight calibration, but bad for joints detection.

==== Step 2: Record Calibration Video ====

Start video recording.

Just walk around the whole capture area, and put hands up from time to time.

{{Tip|The exact movement is not so important, just try to cover the whole capture volume by arms and legs movement, or at least its perimeter.}}

{{Tip|You can use your action videos for calibration, if the body movement conver the whole capture area. Videos when you stand at the same place will not allow for accurate calibration. }}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

==== Step 3: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 4: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains movement around capture area.
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you do not use Sony PS3 Eye camera and do not know camera field of view
* Click '''Calibrate Based on AI Joints''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

Calibration Definition AI

2024-10-30T09:09:10Z

Pavel: Created page with "Calibration is a process of computing accurate camera positions and orientations from a video. This step is essential and required for multi-camera system setup. Calibration..."

Calibration is a process of computing accurate camera positions and orientations from a video. This step is essential and required for multi-camera system setup.

Calibration can be done by user waving a small glowing object called ''marker'' (for color/color+depth cameras). Novel AI-based pose estimation algorithms allow to use AI-detected joint positions instead of glowing object (flashlight), that makes the process simpler.

{{Important|Once you calibrated the camera system, you should not move your cameras for subsequent video shoots. If you move at least one camera, you need to perform calibration again.}}

{{Tip|We recommend to run calibration twice - before and after capture session. If any camera was moved during capture session, calibration made after the session can give you correct camera positions.}}

Multiple PS Eye Cameras Calibration

2024-10-30T08:53:15Z

Pavel:

Multiple PS Eye Cameras Calibration

2024-10-30T08:46:01Z

Pavel:

{{:Calibration Definition}}

=== Flashlight Calibration ===

==== Importance of high frame rate ====

You should record calibration video at the same resolution as your action video and at the same (or higher) frame rate.

Calibration at a different resolution may lead to reduced accuracy because cameras usually have different minor distortions at different resolutions (caused by internal scaling algorithm).

Calibration at low frame rate may lead to reduced accuracy because of increased synchronization errors.

==== Glowing Marker ====
{{:Glowing Marker}}

==== Step 1: Running [[iPi Recorder]] in Calibration Mode ====

Run [[iPi Recorder]] and choose one of the darkening modes in "darkening for calibration" list (for Sony PS Eye cameras)
[[File:Calibration-darkening.png|center|link=]]

or set Exposure to reasonably small value (for DirectShow-compatible web cameras)

[[File:Calibration-exposure.png|center|link=]]

This is important because it helps to reduce motion blur during calibration.

Video will look dim in calibration mode.

{{Important|Do not turn off the light in the room during calibration! This will not help the software but will make it harder for you to see what is happening on recorded video when you view it later.}}

==== Step 2: Record Calibration Video ====

Start video recording.

Move the marker slowly through your entire capture volume (front-top-right-bottom-left-back-top-right-bottom-left). Start from top and move the marker in a descending spiral motion.

{{Tip|The exact trajectory of the marker is not so important, just try to cover the whole capture volume, or at least its perimeter.}}

{{Tip|For successful calibration, several hundred frames are sufficient. Much more frames (like several thousands) will not produce more accurate results, but instead will increase the processing time and possible number of marker detection errors. So generally it is not recommended to record calibration videos of more than 1 minute length.}}

{{Tip|You should make the marker visible to as much cameras as possible at all times. Hold the marker in the straight arm away from your body. In a circle configuration, when approaching the boundary of the capture area, position the marker inside the area, and your body outside.}}

[[File:Calibration1.jpg|center|link=]]

[[File:Calibration2.jpg|center|link=]]

[[File:Calibration3.jpg|center|link=]]

Put the marker to the ground at each corner and at the center of capture volume. At least 4-5 ground points are needed for the correct detection of the groundplane.
<center>
{|
|[[File:Calibration_ground1.jpg|center|400px]]
|[[File:Calibration_ground2.jpg|center|400px]]
|}
</center>

==== Step 3: Stop Recording and Check Recorded Video ====

Check the video and make sure that:

* There is no significant motion blur (image of marker looks like a round spot rather than an ellipse or a luminescent line)
* Most of the time (80%-90% of all recording time) marker is visible in all cameras

==== Step 4: Take Note of Height of Your First Camera Over the Ground. ====

Take note of height of your first camera over the ground. You will need this parameter later.

==== Step 5: Process Calibration Video in [[iPi Mocap Studio]] ====

{{Tip|You can postpone processing calibration video until after you finished recording other videos (e.g. your action videos). However, it is a good idea to process your calibration video as soon as it was recorded because it helps you ensure that you have good calibration. Use '''Regular''' calibration mode (1) if you want to be 100% sure that calibration sequence is fine. Also you can use '''Fast''' calibration mode to save time. But in this case you will need to re-process calibration video later to get maximum calibration quality. I certain cases '''Fast''' calibration mode can fail to calibrate even if calibration sequence is fine and can be calibrated successfully in '''Regular''' calibration mode.}}

To process calibration video please do the following:
* Create new calibration project in [[iPi Mocap Studio]]:
** Press ''New'' button or select '''File > New Project''' menu item or use <tt>Ctrl+N</tt> (2)
*:[[Image:Calibration_Start.png|center|800px]]
** Choose '''Calibration project''' type in '''New Project Wizard'''.
** Set the diagonal '''Field of View''' (FOV) for your cameras.
*:{{Note|If you use Sony PS Eye or Logitech QuickCam 9000 cameras, leave the FOV value at the default 75 degrees.}}
<center>
{|
|[[Image:Select_Project_Type_Calibration.png|center|400px]]
|[[Image:Calibration_Select_Camera_FOV.png|center|400px]]
|}
</center>
* Adjust the [[Region-of-Interest]] to cover the part of video that contains the glowing marker (3).
* Normally, you need to use default calibration settings
** Auto-detect initial camera positions turned on
*** If calibration fails to detect initial camera positions correctly, you can turn this checkbox off and set camera positions manually. But in most cases it will be easier to re-record calibration sequence.
** Auto-adjust camera FOV turned off
*** Use this mode only if you do not use Sony PS3 Eye camera and do not know camera field of view
** '''Regular''' calibration mode
*** In rare cases when '''Regular''' mode fails to calibrate, you can use '''Extended''' and '''Extreme''' calibration modes. It will take much more time, but may help to calibrate correctly if you have high percent of marker misdetections. Usually this is caused by incorrect camera positioning or poor lighting conditions
* Click '''Calibrate''' button and wait while the system finishes calibration (4).

==== Step 6: Check Calibration Quality ====

Resulting scene should look like this:

[[File:Calibration_result1.png|center|800px]]

Make sure you have <span style="color:white; background:#ffd700; padding:5px;">Good</span> or <span style="color:white; background:#8cbf26; padding:5px;">Perfect</span> calibration result.
{{Important|1=<span style="color:white; background:#e93f3f; padding:5px;">Failed</span> calibration is not recommended to use, as you will not be able to get accurate tracking results. However, sometimes '''Failed''' status can be misdetected. If detected marker positions are close to marker image on video in all frames for all sensors, you can use this calibration for tracking.}}

==== Step 7: Check Ground Plane ====
[[Image:Floor-Detection-1.png|thumb|334px|Manual Floor Detection]]
Ground plane should be detected automatically. Ground points are marked by <span style="color:white; background:#ffd700; padding:5px;">yellow</span> color.
* Make sure that ground points are actually near the ground plane.
* If ground plane is detected incorrectly, select ground points manually.
** Expand '''Manual Calibration Adjustment''' expander.
** First, unmark all ground points by pressing '''Clear all points''' button.
** For each ground point, click on it in 3D view and press '''Mark as ground''' button.
** You can cancel marking point as ground point by pressing '''Unmark ground''' button.

{{Important|If you do not mark ground points then the ground plane is incorrect and there is no sense in using Foot tracking option and camera heights values.}}

==== Step 8: Set Scene Scale Using Camera Height as Reference ====

Now cameras in your scene are properly oriented relative to other cameras and relative to ground plane. But you still need to find one more parameter: scene scale.

Use '''Сamera #1''' height over ground to set correct scene scale.

[[File:Calibration_scale1.png|center|800px]]

* Save results to calibration project file or using '''Save scene...''' button on '''Scene''' tab (6).
[[Image:Depth_Project_Scene_Tab.png|center|link=]]

iPi Automation Add-on

2024-10-17T13:48:50Z

Pavel:

= Overview =

'''iPi Automation Add-on''' allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending [http://en.wikipedia.org/wiki/JSON JSON] commands via Windows dll. It can be used for:
* Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution
* Automation of repeatable tasks
* Automation of custom workflow

{{Note| '''iPi Automation Add-on''' requires separate license key, which you need to activate in [[iPi Mocap Studio]]. 30-days free trial provided.}}

= License and Trial =

'''iPi Automation Add-on''' requires separate license key, which you need to activate in [[iPi Mocap Studio]]. You can order your license [https://ipisoft.com/software/automation-add-on/ here], or activate 30-days free trial.
Follow the steps below to start working with '''iPi Automation Add-on'''
# Select menu item '''Help > Manage Licenses > Automation Add-on'''.
# Press '''Start 30-days Free Trial Period''' or '''Enter Automation Add-on License Key''' and follow further on-screen instructions
#:[[Image:iPi-Integration-2-2.png|400px|]]

{{Note|To use '''iPi Automation Add-on''' with [[iPi Recorder]], you have to install [[iPi Mocap Studio]] on the same computer and activate '''iPi Automation Add-on''' following the instructions above. You do not need to activate any other keys (Main or Biomech Add-on), if you do not plan to perform tracking on this computer. }}

= Using iPi Automation Add-on =

== Communication Library ==

In order to enable communication with [[iPi Recorder]] and/or [[iPi Mocap Studio]], your program should use the library '''iPiMocapAutomation.dll'''.

=== Redistributable Contents ===
Redistributable of the library ([https://files.ipisoft.com/iPiMocapAutomation.zip download link]) has the following structure:
* '''bin''' Binary files to redistribute with your program. The library file '''iPiMocapAutomation.dll''' accompanied by C runtime library '''msvcr120.dll''', command line utility '''iPiExec.exe''' and .NET managed wrapper for the library '''iPiMocapAutomation.Net.dll'''.
** '''x86''' 32-bit version
** '''x64''' 64-bit version
* '''include''' Header files for the library. May be used directly in C/C++ programs, or as reference for making proper binding to DLL for other programming languages.
* '''lib''' Static library files for linking with C/C++ programs.
** '''x86''' 32-bit version
** '''x64''' 64-bit version
* '''samples''' Samples of library usage. Currently only for Visual C++ 2013.

=== iPiExec Console Application ===

iPiExec.exe included into the redistributable is a console application that allows to send [http://en.wikipedia.org/wiki/JSON JSON] commands to [[iPi Recorder]] or [[iPi Mocap Studio]] without the need to write software application. It uses the same dll and API to communicate with [[iPi Recorder]] and [[iPi Mocap Studio]].

iPiExec console application can be used for:

* Testing iPi Automation Add-on and specific commands

* Creating scripts for automation of frequent operations

* Integrating iPi Motion Capture into complex production pipelines using scripts

===== Using iPiExec =====

'''Usage:''' <tt>.\iPiExec</tt> <tt>recorder</tt> | <tt>studio</tt>

<tt>recorder</tt> - for connecting to iPi Recorder.

<tt>studio</tt> - for connecting to iPi Mocap Studio.

After connecting just enter commands in JSON format (described below in this documentation). Multi-line commands are not supported, so each command (even long one) should be single-line.

{{Note|According to Windows security policies, <tt>iPiExec</tt> must have at least the same access rights as [[iPi Recorder]] or [[iPi Mocap Studio]] to be able to connect. When [[iPi Recorder]] or [[iPi Mocap Studio]] starts automatically after installation, it runs with Windows Administrator rights. So you need either to run <tt>iPiExec</tt> with Admin rights as well or simply to restart Recorder/Mocap Studio.}}SAMPLE

<syntaxhighlight lang=javascript>

>.\ipiexec recorder
Connecting to iPi Recorder...
Connected!

RECORDER > { "command": "get-app-info" }
Executing: {"command":"get-app-info"}
Received: {"success":true,"result":{"appName":"iPi Recorder 3","appVersion":"3.2.3.45","mainWindowHandle":3673032,"processId":6496}}

RECORDER >
</syntaxhighlight>

To run a set of commands in automatic mode create a text file with a sequence of JSON objects for commands and pass it to '''iPiExec''' via redirecting a standard input. This allows to avoid babysitting '''iPiExec''' and having to enter each command manually.

{{Note|A file with commands should have ANSI encoding or UTF-8 ''without signature'' to support national characters.}}

Contents of a script <tt>commands.txt</tt>:
<syntaxhighlight lang=javascript>
{
"command": "get-app-info"
}
{
"command": "export-video",
"arguments": {
"inputFilePath": "V:\\kinect4a\\single-k4a-nfov.iPiVideo",
"outputFilePath": "D:\\work\\k4a.avi",
"codec": "x264"
}
}
</syntaxhighlight>

Execute with a command <code>.\iPiExec recorder < commands.txt</code>. After executing a script '''iPiExec''' disconnects automatically and then exits.

=== API ===

This library provides a general way of communication with supported applications. A client program establishes a ''connection'' to an application. Then, using this connection, it sends ''commands'' to the application. After executing a command, the application synchronously sends a ''response'' to that command back to a client program. Also, through the same connection, the application asynchronously notifies a client program about occurring events, such as the end of a long-running operation.

Each application has its own set of commands and events. Specific commands/events are out of scope of this library and should be handled in code using it.

==== Connecting and Disconnecting ====

<syntaxhighlight lang=c>
iPi_Result iPi_ConnectToRecorder(LPCWSTR executablePath, iPi_EventCallback fnEventCallback, LPHANDLE phConnection, bool suppressAutoStart = false);
iPi_Result iPi_ConnectToMocapStudio(LPCWSTR executablePath, iPi_EventCallback fnEventCallback, LPHANDLE phConnection, bool suppressAutoStart = false);
</syntaxhighlight>

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>Parameter</th><th>Description</th></tr>
<tr><td>executablePath</td><td>Path to executable file of an application. Optional.</td></tr>
<tr><td>fnEventCallback</td><td>Pointer to a function which handles events coming from an application. Optional.</td></tr>
<tr><td>phConnection</td><td>Receives a connection handle. Required.</td></tr>
<tr><td>suppressAutoStart</td><td>If this flag is set to ''true'', application would not start automatically. Optional. Default value is ''false''.</td></tr>
</table>

Functions '''iPi_ConnectToRecorder''' and '''iPi_ConnectToMocapStudio''' are used to establish connections to corresponding applications.

First, they try to connect to already running application instance if any. An application will refuse the connection if it already has other connection with some client.

If there are no running instances of the application, or they all refuse connection, then a new instance of the application is launched. If '''executablePath''' parameter is specified, then it is used to run the application. Otherwise, the function looks for path to an application in file associations and standard installation directory.

When connection is fully operational, its handle is returned in '''phConnection''' parameter. This handle is used in all subsequent calls for this connection.

{{Note|According to Windows security policies, your app must have at least the same access rights as [[iPi Recorder]] or [[iPi Mocap Studio]] to be able to connect. When [[iPi Recorder]] or [[iPi Mocap Studio]] starts automatically after installation, it runs with Windows Administrator rights. So you need to run your app with Admin rights as well in this case.}}

Parameter '''fnEventCallback''' specifies a function to handle asynchronous application events. See [[#Consuming Events|the section about events]] below.

<syntaxhighlight lang=c>
iPi_Result iPi_Disconnect(HANDLE hConnection);
</syntaxhighlight>

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>Parameter</th><th>Description</th></tr>
<tr><td>hConnection</td><td>Connection handle. Required.</td></tr>
</table>

'''iPi_Disconnect''' closes previously open connection and frees all associated resources.

The function does not close the application itself. To do this, send an exit command specific to the application.

==== Sending Commands ====

<syntaxhighlight lang=c>
iPi_Result iPi_ExecuteCommand(HANDLE hConnection, LPCWSTR jsonCommand, LPWSTR* pJsonResponse);
</syntaxhighlight>

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>Parameter</th><th>Description</th></tr>
<tr><td>hConnection</td><td>Connection handle. Required.</td></tr>
<tr><td>jsonCommand</td><td>Command string. Required.</td></tr>
<tr><td>pJsonResponse</td><td>Receives a response string. Required.</td></tr>
</table>

'''iPi_ExecuteCommand''' is used to send a command to the application. Parameter '''jsonCommand''' contains the command to send.

Response received from the application is placed into '''pJsonResponse'''. When not needed anymore, the returned response string should be freed with '''iPi_Free''' function.

==== Consuming Events ====

To consume asynchronous events coming from the application, client code should specify address of a callback function in '''fnEventCallback''' parameter when opening a connection. If callback is not specified, then application events will be discarded. The type of event callback is defined as follows:

<syntaxhighlight lang=c>
typedef void (WINAPI *iPi_EventCallback)(HANDLE hConnection, LPWSTR jsonEvent);
</syntaxhighlight>

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>Parameter</th><th>Description</th></tr>
<tr><td>hConnection</td><td>Connection handle.</td></tr>
<tr><td>jsonEvent</td><td>Event string.</td></tr>
</table>

Every time an event comes from the application, the library calls this callback function. An event string is passed in '''jsonEvent''' parameter. When not needed, this string should be freed with '''iPi_Free''' function.

A callback is invoked on a thread from the process's thread pool. Each invocation may be on another thread, and multiple invocations may take place in the same time. So pay attention to proper thread synchronization in code.

==== Error Codes ====

Most of API functions has return type '''iPi_Result''', which is enumeration representing error codes. The numeric values of the constants can be found in header file '''iPiTypes.h'''.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Constant</th><th>Description</th></tr>
<tr><td>IPI_OK</td><td>Operation succeeded.</td></tr>
<tr><td>IPI_GENERAL_ERROR</td><td>Some error has occurred, for which there is no more specific error code.</td></tr>
<tr><td>IPI_INVALID_PARAM</td><td>Invalid parameter value in a call to a function.</td></tr>
<tr><td>IPI_OUT_OF_MEMORY</td><td>Not enough memory to complete an operation.</td></tr>
<tr><td>IPI_CONNECTION_BROKEN</td><td>Connection to an application has been broken. Should call '''iPi_Disconnect''' on this one and establish a new connection if needed.</td></tr>
<tr><td>IPI_CANNOT_START_APP</td><td>Application executable file was not found or other problem when starting application.</td></tr>
<tr><td>IPI_CANNOT_CONNECT</td><td>Application is not running or does not accept connections. For example, its an old version of the application which does not support connections. Or limit on connections is reached.</td></tr>
<tr><td>IPI_INVALID_DATA</td><td>Invalid data read from a connection.</td></tr>
</table>

==== Miscellaneous ====

<syntaxhighlight lang=c>
BOOL iPi_Free(LPVOID ptr);
</syntaxhighlight>

Function '''iPi_Free''' should be used to free memory blocks that are allocated by the library and passed to client code, when they are not needed anymore. This includes response strings when executing commands and event strings when consuming events.

== Command Syntax ==

''Commands'' are strings based on [http://en.wikipedia.org/wiki/JSON JSON] syntax. Commands are submitted via [http://en.wikipedia.org/wiki/JSON JSON] ''requests'' that include command name and may optionally include command arguments.

The ''response'' is also [http://en.wikipedia.org/wiki/JSON JSON] string. The response include success flag. In case of error the response include error message. In case of success the response may optionally include result that is [http://en.wikipedia.org/wiki/JSON JSON] object.

Long actions (recording, background evaluation, etc.) initiated by commands generate asynchroneous ''events'' on action completion. Event is described by [http://en.wikipedia.org/wiki/JSON JSON] string that include event name and may include optional arguments, depending on type of event.

''SYNOPSIS''

<syntaxhighlight lang=javascript>
// Request for command without arguments
{
"command": "<command_name_string>"
}

// Request for command with arguments
{
"command": "<command_name_string>",
"arguments":
{
<arguments_list_json_string>
}
}

// Simple response in case of success
{
"success": true
}

// Response including command result field in case of success
{
"success": true,
"result":
{
<result_json_string>
}
}

// Response in case of error
{
"success": false,
"error": "<error_message_string>"
}

// Event without arguments
{
"event": "<event_name_string>"
}

// Event including arguments
{
"event": "<event_name_string>",
"arguments":
{
<arguments_list_json_string>
}
}

</syntaxhighlight>

== iPi Recorder Commands ==

=== General Commands ===

==== get-app-info ====

''get-app-info'' command returns the name of application and its version.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>appName</tt></td><td>string</td><td align=center>mandatory</td><td><tt>iPi Recorder 3</tt></td>
<td>Application name. </td></tr>
<tr><td><tt>appVersion</tt></td><td>string</td><td align=center>mandatory</td><td>Version number in the format <tt>XX.XXX.XXX.XXX</tt></td>
<td>Application version number. </td></tr>
<tr><td><tt>mainWindowHandle</tt></td><td>number</td><td align=center>mandatory</td><td><tt>Integer</tt></td>
<td>Windows API handle of main window.</td></tr>
<tr><td><tt>processId</tt></td><td>number</td><td align=center>mandatory</td><td><tt>Integer</tt></td>
<td>Windows process id.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-app-info"
}

// Response
{
"success":true,
"result":
{
"appName": "iPi Recorder 3",
"appVersion": "99.876.543.210",
"mainWindowHandle":524736,
"processId":12368
}
}
</syntaxhighlight>

==== open-studio ====

''open-studio'' command opens [[iPi Mocap Studio]] and creates the project from specified [[.iPiVideo File Extension|'''.iPiVideo''']] file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path of [[.iPiVideo File Extension|'''.iPiVideo''']] file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "open-studio",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_record.iPiVideo"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== exit ====

''exit'' command closes [[iPi Recorder]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "exit"
}

// Response
{
"success": true
}
</syntaxhighlight>

=== Recording Commands ===

==== open-home-screen ====

''open-home-screen'' opens HOME screen of [[iPi Recorder]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "open-home-screen"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== refresh-device-list ====

''refresh-device-list'' returns the list of available devices.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of JSON objects, each representing recording device. Fields of array items:</td></tr>
<tr><td><tt>kind</tt></td><td>string</td><td align=center>mandatory</td><td><tt>camera</tt><br><tt>depth-sensor</tt><br><tt>microphone</tt></td>
<td>Device type.</td></tr>
<tr><td><tt>model</tt></td><td>string</td><td align=center>mandatory</td><td>Supported device model</td>
<td>Device model.</td></tr>
<tr><td><tt>id</tt></td><td>string</td><td align=center>mandatory</td><td>Unique string, format depends on device model</td>
<td>Unique string that is used to identify recording devices in ''open-recorder'' command.</td></tr>
<tr><td><tt>selected</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device selected status.</td></tr>
<tr><td><tt>failed</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device failed status.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td>Error message string</td>
<td>Error message if device is in failed status.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "refresh-device-list"
}

// Response
{
"success":true,
"result":
[
{
"kind": "camera",
"model": "PlayStation Eye",
"id": "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
"selected": false,
"failed": false
},
{
"kind": "depth-sensor",
"model": "Kinect 2 for Windows",
"id": "Default Kinect 2",
"selected": true,
"failed": true,
"error": "Is not available"
},
{
"kind": "microphone",
"model": "USB Camera-B4.04.27.1",
"id": "Microphone (USB Camera-B4.04.27 [VID=-1; PID=-1; Driver=256; Channels=2; Supports=WAVE_FORMAT_11M08, ...]",
"selected": false,
"failed": false
}
]
}
</syntaxhighlight>

==== open-recorder ====

''open-recorder'' selects devices for recording and switches to SETUP stage.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>selectedDevices</tt></td><td>string array</td><td align=center>mandatory</td><td>List of device id strings</td>
<td>Selecting devices for recording. Device ids are returned by '''refresh-device-list''' command.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "open-recorder",
"arguments":
{
"selectedDevices":
[
"\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
"\\\\?\\usb#vid_1415&pid_2000&mi_00#7&1c1ec232&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}"
]
}

}

// Response
{
"success":true
}
</syntaxhighlight>

==== evaluate-background ====

''evaluate-background'' runs background evaluation.

{{Tip|If parameter is not specified in command arguments, current value in user interface will be used.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>duration</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 2 to 10<td>
Setting duration of background evaluation.
</td></tr>
<tr><td><tt>startDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 30<td>
Setting start delay for background evaluation.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''background-evaluation-stopped''' event is generated when background evaluation ends</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if background evaluation was completed successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if background evaluation was cancelled by user.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Description of the error when background evaluation has failed.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "evaluate-background",
"arguments":
{
"duration": 3,
"startDelay": 1
}
}

// Response
{
"success": true
}

// Event
{
"event": "background-evaluation-stopped",
"arguments":
{
"success": true,
"cancelled": false
}
}
</syntaxhighlight>

==== go-to-screen ====

''go-to-screen'' opens SETUP, BACKGROUND or RECORD screen of [[iPi Recorder]]. /

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>screen</tt></td><td>string</td><td align=center>mandatory</td><td><tt>setup<br>background<br>record</tt></td>
<td>Screen name to open as it is shown in user interface.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "go-to-screen",
"arguments":
{
"screen": "record"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== start-recording ====

''start-recording'' starts recording.

{{Tip|If parameter is not specified in command arguments, current value in user interface will be used.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path<td>
Full path to destination file for recording.
</td></tr>
<tr><td><tt>startDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 60<td>
Setting start delay for recording.
</td></tr>
<tr><td><tt>forceStart</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true</tt><br><tt>false</tt><td>
Setting this flag to <tt>true</tt> allows to start recording despite fps is lower than expected. We recommend first run the command without this flag. If you get fps error message, while fps is generally fine, wait 1 second while statistics recalculates and run the commmand with this flag set to <tt>true</tt>.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''recording-started''' event is generated when recording has started successfully.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path<td>
Full path to destination file.
</td></tr>
<tr><td><tt>startMoment</tt></td><td>string</td><td align=center>mandatory</td><td>Date and time value in format<br/><tt>yyyy-MM-ddTHH:mm:ss.sssssss</tt></td>
<td>Moment when recording has started, in local time.</td></tr>
<tr><td colspan="5">'''recording-stopped''' event is generated when recording is stopped due to sending '''[[#stop-recording|stop-recording]]''' command or abnormally in case of some error.</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if recording is successful.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if recording was cancelled by user before any frame has been recorded.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Error message. Set if there was an error during background evaluation.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path<td>
Full path to destination file. Set on successful recording.
</td></tr>
<tr><td><tt>fileSize</tt></td><td>number</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Size of the recorded file in bytes. Set on successful recording.</td></tr>
<tr><td><tt>duration</tt></td><td>string</td><td align=center>optional</td><td>Timespan value in format<br><tt>hh:mm:ss.sssssss</tt><td>
Duration of the recording. Set on successful recording.
</td></tr>
<tr><td><tt>frameCount</tt></td><td>number</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Number of the recorded frames. Set on successful recording.</td></tr>
<tr><td><tt>statistics</tt></td><td>object</td><td align=center>optional</td><td></td>
<td>Statistics of the recording. Set on successful recording.</td></tr>
<tr><td><tt>slaveResults</tt></td><td>array</td><td align=center>optional</td><td></td>
<td>Results of recording on slave PCs. Set on distributed recording. Fields of array items are described below.</td></tr>
<tr><td style="padding-left:40px"><tt>hostName</tt></td><td>string</td><td align=center>mandatory</td><td></td>
<td>Host name of the slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br/>false</tt></td>
<td>Whether recording on that PC was successful.</td></tr>
<tr><td style="padding-left:40px"><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Error message. Set if there was an error during recording on that slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>remoteFilePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Local path to a recorded iPiVideo file on that slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>statistics</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Statistics of the recording on that slave PC. Set on successful recording.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "start-recording",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_record.iPiVideo",
"startDelay": 1,
"forceStart": true
}
}

// Response
{
"success": true
}

// Event
{
"event": "recording-started",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_record.iPiVideo",
"startMoment": "2017-08-14T10:25:14.6457890"
}
}

// Event
{
"event": "recording-stopped",
"arguments":
{
"success": true,
"cancelled": false,
"filePath": "D:\\iPiMocap\\test_record.iPiVideo",
"fileSize": 39975560,
"duration": "00:00:04.0155425",
"frameCount": 197,
"statistics" :
{
"devicesStatistics" :
[
{
"badFramesPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"deviceName" : "PlayStation Eye #1",
"frameGapsPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"framesPerSecond" :
{
"average" : 60.2884,
"deviation" : 0.436367,
"max" : 62.5,
"min" : 60
},
"maxFrameGap" : 0,
"maxSpanOfBadFrames" : 0,
"totalBadFrames" : 0,
"totalFrameGaps" : 0
},
{
"badFramesPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"deviceName" : "PlayStation Eye #2",
"frameGapsPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"framesPerSecond" :
{
"average" : 60.3032,
"deviation" : 0.450399,
"max" : 62.5,
"min" : 60
},
"maxFrameGap" : 0,
"maxSpanOfBadFrames" : 0,
"totalBadFrames" : 0,
"totalFrameGaps" : 0
},
{
"badFramesPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"deviceName" : "PlayStation Eye #3",
"frameGapsPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"framesPerSecond" :
{
"average" : 60.2264,
"deviation" : 0.321094,
"max" : 61.7,
"min" : 60
},
"maxFrameGap" : 0,
"maxSpanOfBadFrames" : 0,
"totalBadFrames" : 0,
"totalFrameGaps" : 0
}
],
"overallStatistics" :
{
"badFramesPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"deviceName" : "Overall",
"frameGapsPerSecond" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
},
"framesPerSecond" :
{
"average" : 60.2701,
"deviation" : 0.39055,
"max" : 62.1,
"min" : 60
},
"maxFrameGap" : 0,
"maxSpanOfBadFrames" : 0,
"totalBadFrames" : 0,
"totalFrameGaps" : 0
},
"primaryChannelMistiming" :
{
"average" : 0.00180621,
"deviation" : 0.000746511,
"max" : 0.0073028,
"min" : 3.39e-005
},
"secondaryChannelMistiming" :
{
"average" : 0,
"deviation" : 0,
"max" : 0,
"min" : 0
}
},
}
}
</syntaxhighlight>

==== stop-recording ====

''stop-recording'' command stops recording.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''recording-stopped''' event is generated when recording is stopped, either by sending '''stop-recording''' command or abnormally in case of some error.</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if background evaluation was completed successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if recording was cancelled by user before any frame has been recorded.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Error message. Set if there was an error during background evaluation.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path<td>
Full path to destination file. Set on successful recording.
</td></tr>
<tr><td><tt>fileSize</tt></td><td>number</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Size of the recorded file in bytes. Set on successful recording.</td></tr>
<tr><td><tt>duration</tt></td><td>string</td><td align=center>optional</td><td>Timespan value in format<br><tt>hh:mm:ss.sssssss</tt><td>
Duration of the recording. Set on successful recording.
</td></tr>
<tr><td><tt>frameCount</tt></td><td>number</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Number of the recorded frames. Set on successful recording.</td></tr>
<tr><td><tt>statistics</tt></td><td>object</td><td align=center>optional</td><td></td>
<td>Statistics of the recording. Set on successful recording.</td></tr>
<tr><td><tt>slaveResults</tt></td><td>array</td><td align=center>optional</td><td></td>
<td>Results of recording on slave PCs. Set on distributed recording. Fields of array items are described below.</td></tr>
<tr><td style="padding-left:40px"><tt>hostName</tt></td><td>string</td><td align=center>mandatory</td><td></td>
<td>Host name of the slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br/>false</tt></td>
<td>Whether recording on that PC was successful.</td></tr>
<tr><td style="padding-left:40px"><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Error message. Set if there was an error during recording on that slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>remoteFilePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Local path to a recorded iPiVideo file on that slave PC.</td></tr>
<tr><td style="padding-left:40px"><tt>statistics</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Statistics of the recording on that slave PC. Set on successful recording.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "stop-recording"
}

// Response
{
"success": true
}

// Event
{
"event": "recording-stopped",
"arguments":
{
"success": true,
"cancelled": false,
"filePath": "D:\\iPiMocap\\test_record.iPiVideo",
"fileSize": 39975560,
"duration": "00:00:04.0155425",
"frameCount": 197
}
}
</syntaxhighlight>

==== get-devices-state ====

''get-devices-state'' returns the state and statistics for all selected devices.

{{Tip|This command is used to make sure recording process is ok. You can use it before and after recording.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of JSON objects, each representing selected device. Fields of array items:</td></tr>
<tr><td><tt>kind</tt></td><td>string</td><td align=center>mandatory</td><td><tt>camera</tt><br><tt>depth-sensor</tt><br><tt>microphone</tt></td>
<td>Device type.</td></tr>
<tr><td><tt>model</tt></td><td>string</td><td align=center>mandatory</td><td>Supported device model</td>
<td>Device model.</td></tr>
<tr><td><tt>index</tt></td><td>numeric</td><td align=center>mandatory</td><td>Positive integer.</td>
<td>Device index starting from 1 as it is seen in iPi Recorder.</td></tr>
<tr><td><tt>id</tt></td><td>string</td><td align=center>mandatory</td><td>Unique string, format depends on device model</td>
<td>Unique string that is used to identify recording devices in ''open-recorder'' command.</td></tr>
<tr><td><tt>selected</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device selected status.</td></tr>
<tr><td><tt>failed</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device failed status.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td>Error message string</td>
<td>Error message if device is in failed status.</td></tr>
<tr><td><tt>statistics</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Camera statistics.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>frameRate</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Average frame rate.</td></tr>
<tr><td style="padding-left: 40px;"><tt>frameDropsPerSecond</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Average frame drops per second.</td></tr>
<tr><td style="padding-left: 40px;"><tt>badFramesPerSecond</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Average bad frames per second.</td></tr>
<tr><td style="padding-left: 40px;"><tt>totalFrameDrops</tt></td><td>number</td><td align=center>mandatory
</td><td>Integer</td><td>Total frame drops.</td></tr>
<tr><td style="padding-left: 40px;"><tt>totalBadFrames</tt></td><td>number</td><td align=center>mandatory
</td><td>Integer</td><td>Total bad frames.</td></tr>
<tr><td style="padding-left: 40px;"><tt>backgroundAreaPercent</tt></td><td>numeric</td><td align=center>optional
</td><td>Percent value rounded to integer.</td><td>Percent of area equal to recorded background.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-devices-state"
}

// Response
{
"success":true,
"result":
[
{
"kind": "camera",
"model": "PlayStation Eye",
"index": 1,
"id": "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
"selected": true,
"failed": false,
"statistics":
{
"frameRate": 50.0,
"frameDropsPerSecond": 0.0,
"badFramesPerSecond": 0.0,
"totalFrameDrops": 0,
"totalBadFrames": 0,
"backgroundAreaPercent": 76
}
},
{
"kind": "microphone",
"model": "USB Camera-B4.04.27.1",
"index": 2,
"id": "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&1c1ec232&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
"selected": true,
"failed": false,
"statistics":
{
"frameRate": 50.0,
"frameDropsPerSecond": 0.0,
"badFramesPerSecond": 0.0,
"totalFrameDrops": 0,
"totalBadFrames": 0,
"backgroundAreaPercent": 98
}
}
]
}
</syntaxhighlight>

==== get-recorder-props ====

''get-recorder-props'' command gets current properties for setup, background and recording stages specified in user interface.

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">'''Properties for SETUP Stage:'''</td></tr>
<tr><td><tt>videoMode</tt></td><td>string</td><td align=center>mandatory</td><td>
Available modes depend on camera model.
</td><td>
Selected RGB video mode.
</td></tr>
<tr><td><tt>videoModeList</tt></td><td>string array</td><td align=center>mandatory</td><td>
List of available modes depend on camera model.
</td><td>
Possible <tt>videoMode</tt> values.
</td></tr>

<tr><td><tt>videoOrientation</tt></td><td>string</td><td align=center>mandatory</td><td>
<tt>"Landscape"</tt><br/><tt>"Portrait"</tt>
</td><td>
Selected video orientation: <tt>Landscape</tt>/<tt>Portrait</tt>.
</td>

<tr><td><tt>audioMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on microphone model.
</td><td>
Selected audio mode. This field is included into the response, if microphone is selected.
</td></tr>
<tr><td><tt>audeoModeList</tt></td><td>string array</td><td align=center>optional</td><td>
List of available modes depend on microphone model.
</td><td>
Possible <tt>audioMode</tt> values. This field is included into the response, if microphone selected.
</td></tr>

<tr><td><tt>globalDeviceProps</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Device-specific list of properties visible in “SHARED SETTINGS” section of SETUP stage.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation Eye: Darkening for Calibration</tt></td><td>string</td><td align=center>optional
</td><td><tt>"None"</tt><br><tt>"Darkening"</tt><br><tt>"Extra Darkening"</tt></td><td>
Selected darkening mode for Sony PS3 Eye cameras. This field is included into the response, if Sony PS3 Eye camera is selected.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation Eye: Darkening for Calibration/List</tt></td><td>string array</td><td align=center>optional
</td><td>List of available modes</td><td>
Available darkening modes for Sony PS3 Eye cameras. This field is included into the response, if Sony PS3 Eye camera is selected.
</td></tr>
<tr><td><tt>screensInRow</tt></td><td>number</td><td align=center>mandatory</td><td>Integer from 1 to number of cameras<td>
Selected number of screens in a row for multiple camera video view.
</td></tr>
<tr><td><tt>screenLayout</tt></td><td>string</td><td align=center>mandatory</td>
<td>
For RGB cameras:<br>
<tt>"Color"</tt><br><br>
For depth sensors:<br>
<tt>"Depth"</tt><br>
<tt>"Picture in picture"</tt><br>
<tt>"Side by side"</tt><br>
</td><td>
Selected screen layout.
</td></tr>
<tr><td><tt>screenLayoutList</tt></td><td>string array</td><td align=center>mandatory</td>
<td>Available screenLayout modes.</td><td>Available screen layout modes. Depend on type of selected cameras.
</td></tr>
<tr><td colspan="5">'''Properties for BACKGROUND Stage:'''</td></tr>
<tr><td><tt>backgroundEvaluationDuration</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 2 to 10<td>
Selected duration of background evaluation.
</td></tr>
<tr><td><tt>backgroundEvaluationStartDelay</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 0 to 30<td>
Selected start delay for background evaluation.
</td></tr>
<tr><td><tt>showEvaluatedBackground</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Selected show background mode.
</td></tr>
<tr><td colspan="5">'''Properties for RECORD Stage:'''</td></tr>
<tr><td><tt>recordingStartDelay</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 0 to 60<td>
Selected start delay for recording.
</td></tr>
<tr><td><tt>hideBackgroundWhenRecording</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Selected hide background mode.
</td></tr>
<tr><td><tt>destinationFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>
Valid file path
</td><td>
Selected full path to destination file for recording.
</td></tr>
<tr><td><tt>colorCompression</tt></td><td>string</td><td align=center>mandatory</td><td>
<tt>"None"</tt><br>
<tt>"Background subtraction"</tt><br>
<tt>"JPEG"</tt>
</td><td>
Selected RGB video compression mode.
</td></tr>
<tr><td><tt>jpegQuality</tt></td><td>number</td><td align=center>mandatory</td><td>integer from 0 to 100</td><td>
Selected JPEG quality for JPEG compression.
</td></tr>
<tr><td><tt>depthCompression</tt></td><td>string</td><td align=center>mandatory</td><td><tt>"None"</tt><br><tt>"Background subtraction"</tt></td><td>
Selected depth compression mode.
</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-recorder-props"
}

// Response
{
"success": true,
"result":
{
"videoMode": "640x480 color @ 50Hz",
"videoModeList":
[
"640x480 color @ 60Hz",
"640x480 color @ 50Hz",
"640x480 color @ 40Hz",
"640x480 color @ 30Hz",
"640x480 color @ 25Hz",
"320x240 color @ 60Hz",
"320x240 color @ 50Hz",
"320x240 color @ 37Hz",
"320x240 color @ 30Hz"
],
"videoOrientation": "Landscape",
"screensInRow": 1,
"screenLayout": "Color",
"screenLayoutList":
[
"Color"
],
"globalDeviceProps":
{
"PlayStation Eye: Darkening for Calibration": "None",
"PlayStation Eye: Darkening for Calibration/List":
[
"None",
"Darkening",
"Extra Darkening"
]
},
"backgroundEvaluationStartDelay": 5,
"backgroundEvaluationDuration": 2,
"showEvaluatedBackground": false,
"recordingStartDelay": 1,
"hideBackgroundWhenRecording": true,
"destinationFilePath": "D:\\iPiMocap\\<time stamp>.iPiVideo",
"colorCompression": "Jpeg",
"jpegQuality": 100,
"depthCompression": "BackgroundSubtraction"
}

}
</syntaxhighlight>

==== set-recorder-props ====

''set-recorder-props'' command sets properties for setup, background and recording stages.
{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}
<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">'''Properties for SETUP Stage:'''</td></tr>
<tr><td><tt>videoMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on camera model.
</td><td>
Setting RGB video mode. You can see available modes in "Video Mode" combobox at SETUP stage, or get it in the result of '''get-recorder-props''' command.
</td></tr>
<tr><td><tt>videoOrientation</tt></td><td>string</td><td align=center>optional</td><td>
<tt>"Landscape"</tt><br/><tt>"Portrait"</tt>
</td><td>
Setting video orientation: <tt>Landscape</tt>/<tt>Portrait</tt>.
</td></tr>
<tr><td><tt>audioMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on microphone model.
</td><td>
Setting audio mode. You can see available modes in "Audio Mode" combobox at SETUP stage, or get it in the result of '''get-recorder-props''' command.
</td></tr>
<tr><td><tt>globalDeviceProps</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Device-specific list of properties visible in “SHARED SETTINGS” section of SETUP stage.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation Eye: Darkening for Calibration''</tt></td><td>string</td><td align=center>optional
</td><td><tt>"None"</tt><br><tt>"Darkening"</tt><br><tt>"Extra Darkening"</tt></td><td>
Darkening mode for Sony PS3 Eye cameras
</td></tr>
<tr><td><tt>screensInRow</tt></td><td>number</td><td align=center>optional</td><td>Integer from 1 to number of cameras<td>
Setting number of screens in a row for multiple camera video view.
</td></tr>
<tr><td><tt>screenLayout</tt></td><td>string</td><td align=center>optional</td>
<td>
For RGB cameras:<br>
<tt>"Color"</tt><br><br>
For depth sensors:<br>
<tt>"Depth"</tt><br>
<tt>"Picture in picture"</tt><br>
<tt>"Side by side"</tt><br>
</td><td>
Setting screen layout.
</td></tr>
<tr><td colspan="5">'''Properties for BACKGROUND Stage:'''</td></tr>
<tr><td><tt>backgroundEvaluationDuration</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 2 to 10<td>
Setting duration of background evaluation.
</td></tr>
<tr><td><tt>backgroundEvaluationStartDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 30<td>
Setting start delay for background evaluation.
</td></tr>
<tr><td><tt>showEvaluatedBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Show background mode on / off.
</td></tr>
<tr><td colspan="5">'''Properties for RECORD Stage:'''</td></tr>
<tr><td><tt>recordingStartDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 60<td>
Setting start delay for recording.
</td></tr>
<tr><td><tt>hideBackgroundWhenRecording</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Show hide background mode on / off.
</td></tr>
<tr><td><tt>destinationFilePath</tt></td><td>string</td><td align=center>optional</td><td>
Valid file path
</td><td>
Full path to destination file for recording.
</td></tr>
<tr><td><tt>colorCompression</tt></td><td>string</td><td align=center>optional</td><td>
<tt>"None"</tt><br>
<tt>"Background subtraction"</tt><br>
<tt>"JPEG"</tt>
</td><td>
Setting RGB video compression mode.
</td></tr>
<tr><td><tt>jpegQuality</tt></td><td>number</td><td align=center>optional</td><td>integer from 0 to 100</td><td>
JPEG quality for JPEG compression.
</td></tr>
<tr><td><tt>depthCompression</tt></td><td>string</td><td align=center>optional</td><td><tt>"None"</tt><br><tt>"Background subtraction"</tt></td><td>
Setting depth compression mode.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-recorder-props",
"arguments":
{
"colorCompression": "jpeg",
"globalDeviceProps":
{
"PlayStation Eye: Darkening for calibration":"None"
},
"hideBackgroundWhenRecording": true,
"recordingStartDelay": 0,
"videoMode": "640x480 color @ 50Hz"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== discover-slaves ====

''discover-slaves'' finds PCs on the network running [[iPi Recorder]] in the slave mode ready to participate in distributed recording.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>timeout</tt></td><td>string</td><td align=center>optional</td><td>Time span value in format '''hh:mm:ss[.sssssss]'''</td>
<td>Time to wait for slaves to be discovered. Default value is 5 seconds.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of host names of slave PCs which have been found.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "discover-slaves",
"arguments":
{
"timeout": "0:0:2" // 2 seconds
}
}

// Response
{
"success": true,
"result": ["PC-MIKE", "NB-ANDY"]
}
</syntaxhighlight>

==== connect-to-slaves ====

''connect-to-slaves'' connects to PCs on the network running [[iPi Recorder]] in the slave mode for distributed recording.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>timeout</tt></td><td>string</td><td align=center>optional</td><td>Time span value in format '''hh:mm:ss[.sssssss]'''</td>
<td>Time to wait for slaves to be discovered. Default value is 5 seconds.</td></tr>
<tr><td><tt>hostNames</tt></td><td>array</td><td align=center>optional</td><td>Array items are strings.</td>
<td>A list of host names of slave PCs to connect to. If not specified, connects to all slaves found. If some of the specified slaves was not found, the command results in an error.</tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of host names of slave PCs which have been connected.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "connect-to-slaves",
"arguments":
{
"timeout": "0:0:2", // 2 seconds
"hostNames": ["PC-MIKE"] // connect only to this PC
}
}

// Response
{
"success": true,
"result": ["PC-MIKE"]
}
</syntaxhighlight>

==== disconnect-from-slaves ====

''disconnect-from-slaves'' ends existing connection to slave instances of [[iPi Recorder]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "disconnect-from-slaves"
}

// Response
{
"success": true,
}
</syntaxhighlight>

==== enter-slave-mode ====

''enter-slave-mode'' puts [[iPi Recorder]] into the slave mode, enabling it to participate in distributed recording.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "enter-slave-mode"
}

// Response
{
"success": true,
}
</syntaxhighlight>

==== exit-slave-mode ====

''exit-slave-mode'' returns [[iPi Recorder]] from the slave mode.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "exit-slave-mode"
}

// Response
{
"success": true,
}
</syntaxhighlight>

==== start-broadcasting ====

''start-broadcasting'' starts broadcasting data for [[Real-time Tracking for Live Preview|real-time tracking]].

{{AutomationPrimitiveCommand|start-broadcasting}}}

==== stop-broadcasting ====

''stop-broadcasting'' stops broadcasting data for [[Real-time Tracking for Live Preview|real-time tracking]].

{{AutomationPrimitiveCommand|stop-broadcasting}}

==== merge-videos ====

''merge-videos'' performs merging of videos recorded by individual PCs during [[Distributed Recording|distributed recording]], similarly to '''Merge Videos''' button in the toolbar.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>inputFilePaths</tt></td><td>string array</td><td align=center>mandatory</td><td>2 or more valid file paths</td><td>iPiVideo files to merge</td></tr>
<tr><td><tt>outputFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td><td>
Resulting iPiVideo file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''merge-videos-completed''' event is generated when the merge operation ends.</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if video files have been merged successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if operation has been cancelled by user.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td></td>
<td>Description of the error when a merge operation has failed.</td></tr>
</table>

{{Important|If output file exists, it will be overwritten without a notice.}}

{{Tip|It is recommended to use absolute file paths. Relative paths are treated against the current directory of iPi Recorder process.}}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "merge-videos",
"arguments":
{
"inputFilePaths": ["d:\\videos\\test.master.iPiVideo", "d:\\videos\\test.slave0.iPiVideo"],
"outputFilePath": "d:\\videos\\test.iPiVideo"
}
}

// Response
{
"success": true
}

// Event
{
"event": "merge-videos-completed",
"arguments":
{
"success": true,
"cancelled": false
}
}
</syntaxhighlight>

=== Player Commands ===

==== set-player-props ====

''set-player-props'' command sets properties for player.

{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>screensInRow</tt></td><td>number</td><td align=center>optional</td><td>Integer from 1 to number of cameras<td>
Setting number of screens in a row for multiple camera video view.
</td></tr>
<tr><td><tt>hideBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Turn hide background mode on / off.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-player-props",
"arguments":
{
"screensInRow": 2,
"hideBackground": true
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== open-player ====

''open-player'' command opens [[.iPiVideo File Extension|'''.iPiVideo''']] file in player.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path<td>
Full path to file to be opened in player.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "open-player",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_record.iPiVideo"
}
}

// Response
{
"success": true
}

</syntaxhighlight>

==== play-forward ====

''play-forward'' starts playing video forward starting from the current frame. If current frame is the last frame playing starts from the first frame.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''playing-stopped''' event is generated when playing is competed (reached the last frame) or stopped by user</td></tr>
<tr><td colspan="5">''No event arguments''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "play-forward"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== play-backward ====

''play-backward'' starts playing video backward starting from the current frame. If current frame is the first frame playing starts from the last frame.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "play-backward"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== frame-forward ====

''frame-forward'' steps one frame forward. If current frame is the last frame error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "frame-forward"
}

// Response
{
"success": true,
"error": "Last frame reached"
}
</syntaxhighlight>

==== frame-backward ====

''frame-backward'' steps one frame backward. If current frame is the first frame error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "frame-backward"
}

// Response
{
"success": true,
"error": "First frame reached"
}
</syntaxhighlight>

==== go-to-frame ====

''go-to-frame'' command selects current frame. If case of invalid frame index error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>frameIndex</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer<td>
Frame index. The first frame index is 0, the last frame index is ''<total_number_of_frames>'' - 1.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "go-to-frame",
"arguments":
{
"frameIndex": 27
}
}

// Response
{
"success": true
}

</syntaxhighlight>

=== Editor commands ===

==== export-video ====

This command exports color frames from the '''iPiVideo''' format to an AVI.

{{AutomationCommandParams
|args=
{{AutomationCommandParam|name=inputFilePath|values=Valid file path.|desc=
Path to an input iPiVideo file. When omitted, a file currently open in the player is used. If no file is open an error is reported.}}
{{AutomationCommandParam|name=outputFilePath|usage=mandatory|values=Valid file path.|desc=
Path to an input AVI file. It's required to end with the '''.avi''' extension.}}
{{AutomationCommandParam|name=layout|type=JSON object|desc=
Contains options to lay out images from source cameras onto exported frames.}}
{{AutomationCommandParam|name=<div style="padding-left: 40px">cameraOrder</div>|type=array|values=Array of non-negative integers|desc=
Lists zero-based indices of cameras to export. By default all cameras are exported in the original order.
You can omit some cameras, but duplicates are not allowed.}}
{{AutomationCommandParam|name=<div style="padding-left: 40px">columns</div>|type=number|values=A positive integer|desc=
A number of columns in the layout grid. By default the value is selected automatically, taking into account '''rows'''.}}
{{AutomationCommandParam|name=<div style="padding-left: 40px">rows</div>|type=number|values=A positive integer|desc=
A number of rows in the layout grid. By default the value is selected automatically, taking into account '''columns'''.}}
{{AutomationCommandParam|name=startFrame|type=number|values=A non-negative integer|desc=
Specifies the start frame for export (zero-based). Default value is ''0''.}}
{{AutomationCommandParam|name=endFrame|type=number|values=A non-negative integer|desc=
Specifies the end frame number for export (zero-based). Default value is ''<frame count> - 1''.}}
{{AutomationCommandParam|name=codec|desc=
A codec to be used for video compression. When omitted, keeps a previously used codec.
Generally used codecs include '''00000000''' (uncompressed), '''MJPG''' (Motion JPEG), '''X264''' (H.264 codec, [https://sourceforge.net/projects/x264vfw/ download link]).
If specified codec is not supported, the '''error''' field will contain the list of available codecs.}}
{{AutomationCommandParam|name=quality|type=number|values=An integer in the range [1..100]|desc=
The quality setting a codec should use. When omitted, keeps a previously used quality.
Greater values mean better quality and bigger files. Not all codecs respect this setting.}}
|events=
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''video-export-finished''' event is generated when the export operation ends</td></tr>
{{AutomationCommandParam|name=success|usage=mandatory|type=boolean|values=<tt>true<br>false</tt>|desc=
Success flag. Set to <tt>true</tt> if export was completed successfully.}}
{{AutomationCommandParam|name=cancelled|usage=mandatory|type=boolean|values=<tt>true<br>false</tt>|desc=
Cancellation flag. Set to <tt>true</tt> if export was cancelled by user.}}
{{AutomationCommandParam|name=error|type=string|desc=
Description of the error when export has failed.}}
}}

{{Important|If an output file exists, it will be overwritten without a notice.}}

{{Tip|It is recommended to use absolute file paths. Relative paths are treated against the current directory of iPi Recorder process.}}

{{Note|This command doesn't open an input file for playback. If you want such effect then first execute '''open-player''' to open an input file. And then execute '''export-video''' without the '''inputFilePath''' argument.}}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "export-video",
"arguments": {
"inputFilePath": "D:\\videos\\two_kinects2_walk.iPiVideo",
"outputFilePath": "D:\\videos\\export\\export00.avi",
"layout": {
"cameraOrder": [1, 0],
"columns": 1
},
"startFrame": 200,
"codec": "x264"
}
}
// Response
{
"success": true
}

// Event
{
"event": "video-export-finished",
"arguments":
{
"success": true,
"cancelled": false
}
}
</syntaxhighlight>

== iPi Mocap Studio Commands ==

=== General Commands ===

==== get-app-info ====

''get-app-info'' command returns the name of application and its version.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>appName</tt></td><td>string</td><td align=center>mandatory</td><td><tt>iPi Mocap Studio 3</tt></td>
<td>Application name.
</td></tr>
<tr><td><tt>appVersion</tt></td><td>string</td><td align=center>mandatory</td><td>Version number in the format <tt>XX.XXX.XXX.XXX</tt></td>
<td>Application version number.
</td></tr>
<tr><td><tt>mainWindowHandle</tt></td><td>number</td><td align=center>mandatory</td><td><tt>Integer</tt></td>
<td>Windows API handle of main window.</td></tr>
<tr><td><tt>processId</tt></td><td>number</td><td align=center>mandatory</td><td><tt>Integer</tt></td>
<td>Windows process id.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-app-info"
}

// Response
{
"success":true,
"result":
{
"appName": "iPi Mocap Studio 3",
"appVersion": "99.876.543.210",
"mainWindowHandle":19925022,
"processId":7328
}
}
</syntaxhighlight>

==== exit ====

''exit'' command closes [[iPi Mocap Studio]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "exit"
}

// Response
{
"success": true
}
</syntaxhighlight>

=== Project Commands ===

==== create-project ====

''create-project'' creates new project from specified [[.iPiVideo File Extension|'''.iPiVideo''']] file.

===== Action projects =====

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>videoFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path of [[.iPiVideo File Extension|'''.iPiVideo''']] file.
</td></tr>
<tr><td><tt>projectType</tt></td><td>string</td><td align=center>mandatory</td><td><tt>action</tt></td>
<td>Type of the project.
</td></tr>
<tr><td><tt>sceneFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Scene or project file path to take calibration information from: [[.iPiScene File Extension|.iPiScene]], [[.iPiCalib File Extension|.iPiCalib]] or [[.iPiMotion File Extension|.iPiMotion]] file.</td></tr>
<tr><td><tt>actors</tt></td><td>array</td><td align=center>mandatory</td><td></td>
<td>Each item should be either a string containing an [[.iPiActor File Extension|.iPiActor]] file path, or an object specifying actor parameters directly. Fields of such object are listed below.</td></tr>
<tr><td style="padding-left: 40px;"><tt>height</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Height of actor.</td></tr>
<tr><td style="padding-left: 40px;"><tt>gender</tt></td><td>string</td><td align=center>optional</td><td><tt>female<br>male</tt></td>
<td>Gender of actor. Default is <tt>male</tt>.</td></tr>
<tr><td style="padding-left: 40px;"><tt>clothingModel</tt></td><td>string</td><td align=center>optional</td><td><tt>longsleeveshirt<br>tshirt<br>tshirtoverlongsleeveshirt<br></tt></td>
<td>Actor clothing model.<br>Requred for projects recorded with RGB cameras. Default is <tt>longsleeveshirt</tt></td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "create-project",
"arguments":
{
"videoFilePath": "D:\\iPiMocap\\test_project.iPiVideo",
"projectType": "action",
"sceneFilePath": "D:\\iPiMocap\\test_project.iPiScene",
"actors":["D:\\iPiMocap\\test_actor.iPiActor"]
}
}
</syntaxhighlight>

===== Calibration projects =====

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>videoFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path of [[.iPiVideo File Extension|'''.iPiVideo''']] file.
</td></tr>
<tr><td><tt>projectType</tt></td><td>string</td><td align=center>mandatory</td><td><tt>calibration</tt></td>
<td>Type of the project.
</td></tr>
<tr><td><tt>cameraFov</tt></td><td>number</td><td align=center>optional</td><td>Double</td>
<td>Camera diagonal field of view in degrees. Default is <tt>75</tt>.<br/>If the video file contains valid FOV values for cameras, they override the value of this parameter.
</td></tr>
<tr><td><tt>autoAdjustFov</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Switches auto detection of camera field of view. Default is <tt>false</tt>.
</td></tr>
<tr><td><tt>autoDetectInitialCameraPositions</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Switches auto detection of initial camera positions. Default is <tt>true</tt>.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "create-project",
"arguments":
{
"videoFilePath": "D:\\iPiMocap\\test_calibration.iPiVideo",
"projectType": "calibration",
"cameraFov": 80,
}
}
</syntaxhighlight>

==== open-project ====

''open-project'' command opens existing project from specified [[.iPiMotion File Extension|'''.iPiMotion''']] file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path of [[.iPiMotion File Extension|'''.iPiMotion''']] file.
</td></tr>
<tr><td><tt>videoFilePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Full path of [[.iPiVideo File Extension|'''.iPiVideo''']] file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "open-project",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_project.iPiMotion",
"videoFilePath": "D:\\iPiMocap\\test_project.iPiVideo"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== save-project ====

''save-project'' command saves current project to file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Full path of [[.iPiMotion File Extension|'''.iPiMotion''']] file.<br>You do not need to specify file path if you save previously opened project to the same file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "save-project",
"arguments":
{
"filePath": "D:\\iPiMocap\\test_project.iPiMotion"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== close-project ====

''close-project'' command closes project curretnly opened in [[iPi Mocap Studio]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "close-project"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== get-project-info ====

''get-project-info'' command returns current project information.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>projectType</tt></td><td>string</td><td align=center>mandatory</td><td><tt>action<br>calibration<br>dummy</tt></td>
<td>Type of the project. Dummy stands for empty project.
</td></tr>
<tr><td><tt>camerasType</tt></td><td>string</td><td align=center>mandatory</td><td><tt>Depth<br>RGB</tt></td>
<td>Type of the cameras.
</td></tr>
<tr><td><tt>camerasCount</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of cameras.
</td></tr>

</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-project-info"
}

// Response
{
"success":true,
"result":
{
"projectType": "action",
"camerasType": "RGB",
"camerasCount": 6
}
}
</syntaxhighlight>

=== Project Properties Commands ===

==== get-timeline-props ====

''get-timeline-props'' command returns timeline properties of the current project.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>timeline</tt></td><td>TimelineClip JSON object</td><td align=center>mandatory</td><td></td>
<td>Whole timeline properties.
</td></tr>
<tr><td><tt>regionOfInterest</tt></td><td>TimelineClip JSON object</td><td align=center>mandatory</td><td></td>
<td>Region of Interest (ROI) properties.
</td></tr>
<tr><td><tt>takes</tt></td><td>TimelineClip JSON objects array</td><td align=center>mandatory</td><td></td>
<td>List of takes.</td></tr>
<tr><td colspan=5>TimelineClip JSON objects properties:</td></tr>
<tr><td style="padding-left: 40px;"><tt>beginFrame</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Begin frame index (first frame is 0).</td></tr>
<tr><td style="padding-left: 40px;"><tt>framesCount</tt></td><td>number</td><td align=center>mandatory</td><td>Positive integer</td>
<td>Number of frames.</td></tr>
<tr><td style="padding-left: 40px;"><tt>secondsPerFrame</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Seconds per frame.</td></tr>
<tr><td style="padding-left: 40px;"><tt>durationInSeconds</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Duration in seconds.</td></tr>
<tr><td style="padding-left: 40px;"><tt>description</tt></td><td>string</td><td align=center>optional</td><td>string</td>
<td>Description.</td></tr></table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-timeline-props"
}

// Response
{
"success": true,
"result":
{
"timeline":
{
"beginFrame": 0,
"framesCount": 758,
"secondsPerFrame": 0.02,
"durationInSeconds": 15.1399
},
"regionOfInterest":
{
"beginFrame": 0,
"framesCount": 758,
"secondsPerFrame": 0.02,
"durationInSeconds": 15.1399,
"description": "Region of Interest"
},
"takes":
[
{
"beginFrame": 0,
"framesCount": 758,
"secondsPerFrame": 0.02,
"durationInSeconds": 15.1399,
"description": "Take 1"
}
]
}
}
</syntaxhighlight>

==== set-timeline-props ====

''set-timeline-props'' command sets timeline properties of the current project.

{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>regionOfInterest</tt></td><td>TimelineClip JSON object</td><td align=center>mandatory</td><td></td>
<td>Region of Interest (ROI) properties.
</td></tr>
<tr><td><tt>takes</tt></td><td>TimelineClip JSON objects array</td><td align=center>mandatory</td><td></td>
<td>List of takes.</td></tr>
<tr><td colspan=5>TimelineClip JSON objects properties:</td></tr>
<tr><td style="padding-left: 40px;"><tt>beginFrame</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Begin frame index (first frame is 0).</td></tr>
<tr><td style="padding-left: 40px;"><tt>framesCount</tt></td><td>number</td><td align=center>mandatory</td><td>Positive integer</td>
<td>Number of frames.</td></tr>
<tr><td style="padding-left: 40px;"><tt>description</tt></td><td>string</td><td align=center>optional</td><td>string</td>
<td>Description.</td></tr><tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-timeline-props",
"arguments":
{
"regionOfInterest":
{
"beginFrame": 10,
"framesCount": 558,
},
"takes":
[
{
"beginFrame": 10,
"framesCount": 158,
"description": "Take 1"
},
{
"beginFrame": 200,
"framesCount": 558,
"description": "Take 2"
}
]
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== get-view-props ====

''get-view-props'' command gets current view properties specified via ''View'' menu.

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''General view properties''</td></tr>
<tr><td><tt>skin</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show skin flag value.</td></tr>
<tr><td><tt>skinOpacity</tt></td><td>numeric</td><td align=center>mandatory</td><td>Double from 0 to 1</td>
<td>Skin opacity value.</td></tr>
<tr><td><tt>bones</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show bones flag value.</td></tr>
<tr><td><tt>viewportBackgroundColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Viewport background color.</td></tr>
<tr><td><tt>cameras</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show cameras flag value.</td></tr>
<tr><td><tt>currentCamera</tt></td><td>numeric</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Selected camera index starting from 0.</td></tr>
<tr><td><tt>groundPlane</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show ground plane flag value.</td></tr>
<tr><td><tt>viewBackground</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show background flag value.</td></tr>
<tr><td colspan="5">''Action projects view properties''</td></tr>
<tr><td><tt>currentActor</tt></td><td>numeric</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Selected actor index starting from 0.</td></tr>
<tr><td><tt>trajectories</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show trajectories flag value.</td></tr>
<tr><td><tt>skeletonStrobe</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show skeleton strobe flag value.</td></tr>
<tr><td><tt>extraSkeletonStrobe</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show extra skeleton strobe flag value.</td></tr>
<tr><td><tt>collisionObjects</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show collision objects flag value.</td></tr>
<tr><td><tt>massObjects</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show mass objects flag value.</td></tr>
<tr><td><tt>poseMismatch</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show pose mismatch flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing RGB information''</td></tr>
<tr><td><tt>video</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show video flag value.</td></tr>
<tr><td><tt>videoOpacity</tt></td><td>numeric</td><td align=center>mandatory</td><td>Double from 0 to 1</td>
<td>Video opacity value.</td></tr>
<tr><td><tt>videoThumbnails</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show video thumbnails flag value.</td></tr>
<tr><td><tt>lightSource</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show light source flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing depth information''</td></tr>
<tr><td><tt>depth</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show depth flag value.</td></tr>
<tr><td><tt>depthOpacity</tt></td><td>numeric</td><td align=center>mandatory</td><td>Double from 0 to 1</td>
<td>Depth opacity value.</td></tr>
<tr><td><tt>hideBackground</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Hide background flag value.</td></tr>
<tr><td><tt>depthFromAllSensors</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Show depth from all sensors flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing RGB and depth information''</td></tr>
<tr><td><tt>alignColorVideoToDepth</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Align color video to depth flag value.</td></tr>
<tr><td><tt>colorPointCloudWithRgbData</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Color point cloud with RGB data flag value.</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-view-props"
}

// Response
{
"success": true,
"result":
{
"skin": true,
"skinOpacity": 0.7,
"bones": true,
"viewportBackgroundColor": "#7D90A3",
"cameras": true,
"currentCamera": 0,
"groundPlane": true,
"viewBackground": false,
"currentActor": 0,
"trajectories": false,
"skeletonStrobe": false,
"extraSkeletonStrobe": false,
"collisionObjects": false,
"massObjects": false,
"poseMismatch": false,
"video": true,
"videoOpacity": 0.7,
"videoThumbnails": true,
"lightSource": true
}

}
</syntaxhighlight>

==== set-view-props ====

''set-view-props'' command sets view properties specified via ''View'' menu.

{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''General view properties''</td></tr>
<tr><td><tt>skin</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show skin flag value.</td></tr>
<tr><td><tt>skinOpacity</tt></td><td>numeric</td><td align=center>optional</td><td>Double from 0 to 1</td>
<td>Skin opacity value.</td></tr>
<tr><td><tt>bones</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show bones flag value.</td></tr>
<tr><td><tt>viewportBackgroundColor</tt></td><td>string</td><td align=center>optional</td><td>Valid html color value</td>
<td>Viewport background color.</td></tr>
<tr><td><tt>cameras</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show cameras flag value.</td></tr>
<tr><td><tt>currentCamera</tt></td><td>numeric</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Selected camera index starting from 0.</td></tr>
<tr><td><tt>groundPlane</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show ground plane flag value.</td></tr>
<tr><td><tt>viewBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show background flag value.</td></tr>
<tr><td colspan="5">''Action projects view properties''</td></tr>
<tr><td><tt>currentActor</tt></td><td>numeric</td><td align=center>optional</td><td>Non-negative integer</td>
<td>Selected actor index starting from 0.</td></tr>
<tr><td><tt>trajectories</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show trajectories flag value.</td></tr>
<tr><td><tt>skeletonStrobe</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show skeleton strobe flag value.</td></tr>
<tr><td><tt>extraSkeletonStrobe</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show extra skeleton strobe flag value.</td></tr>
<tr><td><tt>collisionObjects</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show collision objects flag value.</td></tr>
<tr><td><tt>massObjects</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show mass objects flag value.</td></tr>
<tr><td><tt>poseMismatch</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show pose mismatch flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing RGB information''</td></tr>
<tr><td><tt>video</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show video flag value.</td></tr>
<tr><td><tt>videoOpacity</tt></td><td>numeric</td><td align=center>optional</td><td>Double from 0 to 1</td>
<td>Video opacity value.</td></tr>
<tr><td><tt>videoThumbnails</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show video thumbnails flag value.</td></tr>
<tr><td><tt>lightSource</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show light source flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing depth information''</td></tr>
<tr><td><tt>depth</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show depth flag value.</td></tr>
<tr><td><tt>depthOpacity</tt></td><td>numeric</td><td align=center>optional</td><td>Double from 0 to 1</td>
<td>Depth opacity value.</td></tr>
<tr><td><tt>hideBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Hide background flag value.</td></tr>
<tr><td><tt>depthFromAllSensors</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Show depth from all sensors flag value.</td></tr>
<tr><td colspan="5">''View properties of projects containing RGB and depth information''</td></tr>
<tr><td><tt>alignColorVideoToDepth</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Align color video to depth flag value.</td></tr>
<tr><td><tt>colorPointCloudWithRgbData</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Color point cloud with RGB data flag value.</td></tr><tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-view-props",
"arguments":
{
"currentActor": 0,
"skin": false,
"skinOpacity": 0.5,
"bones": true,
"viewportBackgroundColor": "#7D90A3",
"cameras": true,
"currentCamera": 2,
"groundPlane": true,
"videoOpacity": 0.6,
"videoThumbnails": false,
"lightSource": true
}
}

// Response
{
"success": true
}
</syntaxhighlight>

=== Scene Commands ===

==== load-scene ====

''load-scene'' loads scene and light information from [[.iPiScene File Extension|'''.iPiScene''']], [[.iPiCalib File Extension|'''.iPiCalib''']] or [[.iPiMotion File Extension|'''.iPiMotion''']] file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "load-scene",
"arguments":
{
"filePath": "D:\\iPiMocap\\test.iPiMotion"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== save-scene ====

''save-scene'' saves scene and light information (if available) to [[.iPiScene File Extension|'''.iPiScene''']] file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "save-scene",
"arguments":
{
"filePath": "D:\\iPiMocap\\test.iPiScene"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== recenter-coordinates-on-character ====

''recenter-coordinates-on-character'' aligns coordinate system with character pose.
<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "recenter-coordinates-on-character"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== move-coordinate-system ====

''move-coordinate-system'' allows to change coordinate system. Y axis remains vertical relative to detected ground plane.
<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>shiftX</tt></td><td>string</td><td align=center>optional</td><td>Double</td>
<td>Shift of coordinate system along X axis, in meters.</td></tr>
<tr><td><tt>shiftY</tt></td><td>string</td><td align=center>optional</td><td>Double</td>
<td>Shift of coordinate system along Y axis, in meters. Is used to tune ground height.</td></tr>
<tr><td><tt>shiftZ</tt></td><td>string</td><td align=center>optional</td><td>Double</td>
<td>Shift of coordinate system along Z axis, in meters.</td></tr>
<tr><td><tt>cameraAzimuth</tt></td><td>string</td><td align=center>optional</td><td>Double</td>
<td>Sets azimuth angle of current camera, in degrees.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "move-coordinate-system",
"arguments":
{
"shiftX": 0.23,
"shiftY": -0.02,
"shiftZ": -0.6,
"cameraAzimuth": 0.0
}
}

// Response
{
"success": true
}
</syntaxhighlight>

=== Actor Commands ===

==== load-actor ====

''load-actor'' loads actor properties from ''.iPiActor'' file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>actorIndex</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Actor index starting from 0.
</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "load-actor",
"arguments":
{
"actorIndex": 0,
"filePath": "D:\\iPiMocap\\test.iPiActor"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== save-actor ====

''save-actor'' saves actor properties to ''.iPiActor'' file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>actorIndex</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Actor index starting from 0.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "save-actor",
"arguments":
{
"actorIndex": 0,
"filePath": "D:\\iPiMocap\\test.iPiActor"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== detect-actor-colors ====

''detect-actor-colors'' runs auto-detection of actor colors.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>handsColorSameAsFace</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Setting "Hands are the Same Color as Face" flag value.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''detect-actor-colors-finished''' event is generated when operation is competed or stopped by user</td></tr>
<tr><td><tt>shirtColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Shirt color.</td></tr>
<tr><td><tt>pantsColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Pants color.</td></tr>
<tr><td><tt>handsColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Hands color.</td></tr>
<tr><td><tt>faceColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Face color.</td></tr>
<tr><td><tt>shoesColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Shoes color.</td></tr>
<tr><td><tt>shoeSolesColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Shoe soles color.</td></tr>
<tr><td><tt>hairColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Hair color.</td></tr>
<tr><td><tt>sleevesColor</tt></td><td>string</td><td align=center>mandatory</td><td>Valid html color value</td>
<td>Sleeves color.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "detect-actor-colors",
"arguments":
{
"handsColorSameAsFace": false
}
}

// Response
{
"success": true
}

// Event
{
"event": "detect-actor-colors-finished",
"arguments":
{
"shirtColor":"#384662",
"pantsColor":"#1F2431",
"handsColor":"#9A9DA6",
"faceColor":"#7A7077",
"shoesColor":"#504C4C",
"shoeSolesColor":"#504C4C",
"hairColor":"#57555E",
"sleevesColor":"#384662"
}
}
</syntaxhighlight>

==== get-actor-props ====

''get-actor-props'' returns actor properties.
<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>gender</tt></td><td>string</td><td align=center>mandatory</td><td><tt>female<br>male</tt></td>
<td>Gender of actor.</td></tr>
<tr><td><tt>height</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Height of actor.</td></tr>
<tr><td><tt>clothingModel</tt></td><td>string</td><td align=center>optional</td><td><tt>longsleeveshirt<br>tshirt<br>tshirtoverlongsleeveshirt<br></tt></td>
<td>Actor clothing model.<br>Requred for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>shirtLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Shirt length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>longSleeveLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Long sleeve length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>shortSleeveLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Short sleeve length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>dimensions</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>Actor dimensions.</td></tr>
<tr><td style="padding-left: 40px;"><tt>headHeight</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Height of head from chin to top in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>shouldersWidth</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Distance between shoulder joints in T-pose in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>armLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of straight arm between shoulder and wrist joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>forearmLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of forearm between elbow and wrist joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>legLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of straight leg between hip and ankle joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>lowerlegLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of lower leg between knee and ankle joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>footLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length foot between heel and big toe end in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bodyMassIndex</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Body mass index. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>chestScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Chest scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bustScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Bust scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>waistScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Waist scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>hipsScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Hips scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bellyScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Belly scale factor. 0 means default value.</td></tr>
</table>

{{Note| Dimensions are set approximately to minimize standard deviation from the specified segment lengths. Specifying incorrect values will lead to incorrect body dimensions thus increasing tracking errors. So visual alignment of the model with actual video is highly recommended. }}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-actor-props"
}

// Response
{
"success": true,
"result":
{
"gender": "female",
"height": 1.8,
"clothingModel": "tshirtoverlongsleeveshirt",
"dimensions":
{
"headHeight": 0.21,
"shouldersWidth": 0.3,
"armLength": 0.57,
"legLength": 0.89,
"footLength": 0.26
}
}
}
</syntaxhighlight>

==== set-actor-props ====

''set-actor-props'' sets actor properties.
<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>gender</tt></td><td>string</td><td align=center>mandatory</td><td><tt>female<br>male</tt></td>
<td>Gender of actor.</td></tr>
<tr><td><tt>height</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Height of actor.</td></tr>
<tr><td><tt>clothingModel</tt></td><td>string</td><td align=center>optional</td><td><tt>longsleeveshirt<br>tshirt<br>tshirtoverlongsleeveshirt<br></tt></td>
<td>Actor clothing model.<br>Requred for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>shirtLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Shirt length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>longSleeveLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Long sleeve length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>shortSleeveLength</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Short sleeve length. 0 means default value. Available for projects recorded with RGB cameras.</td></tr>
<tr><td><tt>dimensions</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>Actor dimensions.</td></tr>
<tr><td style="padding-left: 40px;"><tt>headHeight</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Height of head from chin to top in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>shouldersWidth</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Distance between shoulder joints in T-pose in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>armLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of straight arm between shoulder and wrist joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>forearmLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of forearm between elbow and wrist joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>legLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of straight leg between hip and ankle joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>lowerlegLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length of lower leg between knee and ankle joints in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>footLength</tt></td><td>number</td><td align=center>optional
</td><td>Double</td><td>Length foot between heel and big toe end in meters.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bodyMassIndex</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Body mass index. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>chestScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Chest scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bustScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Bust scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>waistScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Waist scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>hipsScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Hips scale factor. 0 means default value.</td></tr>
<tr><td style="padding-left: 40px;"><tt>bellyScale</tt></td><td>number</td><td align=center>optional
</td><td>Double from -1 to 1</td><td>Belly scale factor. 0 means default value.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

{{Note| Dimensions are set approximately to minimize standard deviation from the specified segment lengths. Specifying incorrect values will lead to incorrect body dimensions thus increasing tracking errors. So visual alignment of the model with actual video is highly recommended. }}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-actor-props",
"arguments":
{
"gender": "female",
"height": 1.8,
"clothingModel": "tshirtoverlongsleeveshirt",
"dimensions":
{
"headHeight": 0.21,
"shouldersWidth": 0.3,
"armLength": 0.57,
"legLength": 0.89,
"footLength": 0.26
}
}
}
</syntaxhighlight>

=== Playing Commands ===

==== play-forward ====

''play-forward'' starts playing forward starting from the current frame. If current frame is the last frame playing starts from the first frame.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "play-forward"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== play-backward ====

''play-backward'' starts playing backward starting from the current frame. If current frame is the first frame playing starts from the last frame.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "play-backward"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== frame-forward ====

''frame-forward'' steps one frame forward. If current frame is the last frame error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "frame-forward"
}

// Response
{
"success": false,
"error": "Frame index exceeds total frames count"
}
</syntaxhighlight>

==== frame-backward ====

''frame-backward'' steps one frame backward. If current frame is the first frame error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "frame-backward"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== go-to-frame ====

''go-to-frame'' command selects current frame. If case of invalid frame index error message returned.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>frameIndex</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer<td>
Frame index. The first frame index is 0, the last frame index is ''<total_number_of_frames>'' - 1.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "go-to-frame",
"arguments":
{
"frameIndex": 27
}
}

// Response
{
"success": true
}

</syntaxhighlight>

==== pause-play ====

''pause-play'' pauses playing.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "pause-play"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== export-video ====

''export-video'' command exports viewport to avi video.
<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>fileName</tt></td><td>string</td><td align=center>mandatory</td><td>File name<td>
File name. Must include <tt>.avi</tt> extension.</td></tr>
<tr><td><tt>encoding</tt></td><td>string</td><td align=center>mandatory</td><td><tt>Uncompressed<br>Jpeg</tt><td>
Video encoding.</td></tr>
<tr><td><tt>quality</tt></td><td>number</td><td align=center>optional</td><td>Integer within [1,100]<td>
Jpeg quality. Must be specified for <tt>Jpeg</tt>. Must not be specified for <tt>Uncompressed</tt>.</td></tr>
<tr><td><tt>takeIndex</tt></td><td>number</td><td align=center>optional</td><td>Non-negative integer<td>
Zero-based take index. If not specified, Region-of-Interest is exported.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "export-video",
"arguments":
{
"fileName": "D:\\iPiMocap\\textexport.avi",
"encoding": "jpeg",
"quality": 70,
"takeIndex": 0
}
}

// Response
{
"success": true
}

// Event
{
"event": "video-export-finished",
"arguments":
{
"elapsedTime": 62.321,
"fps": 4.05963,
"framesProcessed": 253
}
}

</syntaxhighlight>

=== Tracking Commands ===

==== get-tracking-props ====

''get-tracking-props'' command gets current tracking properties specified in ''Tracking'' or ''Live'' tab.

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>useFastTrackingAlgorithm</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Whether fast tracking algorithm is used. Not returned for projects with RGB, multiple actors or multiple GPUs, and for live session.</td></tr>
<tr><td><tt>enableFootTracking</tt></td><td>boolean</td><td align=center><tt>obsolete</tt></td><td><tt>true<br>false</tt></td>
<td>Foot tracking enabled flag value.</td></tr>
<tr><td><tt>feetTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Feet'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected feet tracking mode.</td></tr>
<tr><td><tt>enableGroundCollisions</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Ground collisions enabled flag value.</td></tr>
<tr><td><tt>enableHeadTracking</tt></td><td>boolean</td><td align=center><tt>obsolete</tt></td><td><tt>true<br>false</tt></td>
<td>Head tracking enabled flag value.</td></tr>
<tr><td><tt>headTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Head'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected head tracking mode.</td></tr>
<tr><td><tt>handsTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Hands'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected hands tracking mode.</td></tr>
<tr><td><tt>shouldersTrackingMode</tt></td><td>number</td><td align=center>mandatory</td>
<td>Integer index of selected ''Shoulders'' combobox item.<br><tt>0</tt> - ''Calculated from arm position''<br><tt>1</tt> - ''Tracked from video''</td>
<td>Selected shoulder tracking mode.</td></tr>
<tr><td><tt>spineTrackingMode</tt></td><td>number</td><td align=center>mandatory</td>
<td>Integer index of selected ''Spine'' combobox item.<br><tt>0</tt> - ''Stiff Lower Spine''<br><tt>1</tt> - ''Flexible Lower Spine''<br><tt>2</tt> - ''Very Flexible Lower Spine''</td>
<td>Selected spine tracking mode.</td></tr>
<tr><td><tt>trackingResolution</tt></td><td>number</td><td align=center>mandatory</td>
<td>Integer index of selected ''Tracking resolution'' combobox item.<br><tt>0</tt> - ''High''<br><tt>1</tt> - ''Low''</td>
<td>Selected tracking resolution.</td></tr>
<tr><td><tt>jitterRemovalOptions</tt></td><td>number array</td><td align=center>optional</td>
<td>Array containing 6 integers each in the range from 0 to 5.<br><tt>Item 0</tt> - value for ''Torso''<br><tt>Item 1</tt> - value for ''Left arm''<br><tt>Item 2</tt> - value for ''Right arm''<br><tt>Item 3</tt> - value for ''Left leg''<br><tt>Item 4</tt> - value for ''Right leg''<br><tt>Item 5</tt> - value for ''Head''</td>
<td>Selected jitter removal options. Not returned for live sessions.</td></tr>
<tr><td><tt>trajectoryFilter</tt></td><td>number</td><td align=center>optional</td>
<td>Integers in the range from 0 to 5.</td><td>Selected trajectory filter value. Not returned for live sessions.</td></tr>
<tr><td><tt>liveSmoothingFilter</tt></td><td>integer</td><td align=center>optional</td>
<td>Ranged from 0 to 75.</td><td>Actual value of smoothing filter for live session. Not returned for regular projects.</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-tracking-props"
}

// Response
{
"success": true,
"result":
{
"feetTrackingMode": 1,
"enableGroundCollisions": true,
"headTrackingMode": 0,
"handsTrackingMode": 2,
"shouldersTrackingMode": 1,
"spineTrackingMode": 0,
"trackingResolution": 0,
"jitterRemovalOptions": [2, 2, 2, 2, 2, 2],
"trajectoryFilter": 2
}

}
</syntaxhighlight>

==== set-tracking-props ====

''set-tracking-props'' command sets tracking properties in ''Tracking'' or ''Live'' tab.

{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>enableFootTracking</tt></td><td>boolean</td><td align=center><tt>obsolete</tt></td><td><tt>true<br>false</tt></td>
<td>Foot tracking enabled flag value.</td></tr>
<tr><td><tt>feetTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Feet'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected feet tracking mode.</td></tr><tr><td><tt>enableGroundCollisions</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Ground collisions enabled flag value.</td></tr>
<tr><td><tt>enableHeadTracking</tt></td><td>boolean</td><td align=center><tt>obsolete</tt></td><td><tt>true<br>false</tt></td>
<td>Head tracking enabled flag value.</td></tr>
<tr><td><tt>headTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Head'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected head tracking mode.</td></tr>
<tr><td><tt>handsTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Hands'' combobox item.<br><tt>0</tt> - ''Track''<br><tt>1</tt> - ''Do not track''<br><tt>2</tt> - ''Track (AI-based)''</td>
<td>Selected hands tracking mode.</td></tr><tr><td><tt>shouldersTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Shoulders'' combobox item.<br><tt>0</tt> - ''Calculated from arm position''<br><tt>1</tt> - ''Tracked from video''</td>
<td>Selected shoulder tracking mode.</td></tr>
<tr><td><tt>spineTrackingMode</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Spine'' combobox item.<br><tt>0</tt> - ''Stiff Lower Spine''<br><tt>1</tt> - ''Flexible Lower Spine''<br><tt>2</tt> - ''Very Flexible Lower Spine''</td>
<td>Selected spine tracking mode.</td></tr>
<tr><td><tt>trackingResolution</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected ''Tracking resolution'' combobox item.<br><tt>0</tt> - ''High''<br><tt>1</tt> - ''Low''</td>
<td>Selected tracking resolution.</td></tr>
<tr><td><tt>useFastTrackingAlgorithm</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Use fast tracking algorthm flag value.<br/>''Currently available only for regular projects with depth sensors, single actor and single GPU tracking.''</td></tr>
<tr><td><tt>jitterRemovalOptions</tt></td><td>number array</td><td align=center>optional</td>
<td>Array containing 6 integers each in the range from 0 to 5.<br><tt>Item 0</tt> - value for ''Torso''<br><tt>Item 1</tt> - value for ''Left arm''<br><tt>Item 2</tt> - value for ''Right arm''<br><tt>Item 3</tt> - value for ''Left leg''<br><tt>Item 4</tt> - value for ''Right leg''<br><tt>Item 5</tt> - value for ''Head''</td>
<td>Selected jitter removal options. Not allowed for live session.</td></tr>
<tr><td><tt>trajectoryFilter</tt></td><td>number</td><td align=center>optional</td>
<td>Integers in the range from 0 to 5.</td><td>Selected trajectory filter value. Not allowed for live session.</td></tr>
<tr><td><tt>liveSmoothingFilter</tt></td><td>integer</td><td align=center>optional</td>
<td>Ranged from 0 to 75.</td><td>Value of smoothing filter for live session. Greater values make motion look smoother. Not allowed for regular projects.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-tracking-props",
"arguments":
{
"feetTrackingMode": 1,
"enableGroundCollisions": false,
"headTrackingMode": 0,
"handsTrackingMode": 2,
"shouldersTrackingMode": 0,
"spineTrackingMode": 2,
"trackingResolution": 0,
"jitterRemovalOptions": [5, 4, 3, 2, 1, 0],
"trajectoryFilter": 3
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== detect-pose ====

''detect-pose'' applies AI tracking in current frame and sets pose based on the result.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "detect-pose"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== refit-pose ====

''refit-pose'' starts ''Refit Pose'' operation.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''refit-pose-finished''' event is generated when operation is competed or stopped by user</td></tr>
<tr><td><tt>mismatch</tt></td><td>Number</td><td align=center>mandatory</td><td>Double</td>
<td>Pose mismatch value.</td></tr>
<tr><td><tt>translation</tt></td><td>JSON object</td><td align=center>mandatory</td><td></td>
<td>Coordinates of root bone translation.</td></tr>
<tr><td style="padding-left: 40px;"><tt>x</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>x cooordinate.</td></tr>
<tr><td style="padding-left: 40px;"><tt>y</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>y cooordinate.</td></tr>
<tr><td style="padding-left: 40px;"><tt>z</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>z cooordinate.</td></tr>
<tr><td><tt>joints</tt></td><td>JSON objects array</td><td align=center>mandatory</td><td></td>
<td>List of joints rotations.</td></tr>
<tr><td style="padding-left: 40px;"><tt>name</tt></td><td>string</td><td align=center>string</td><td></td>
<td>Name of joint.</td></tr>
<tr><td style="padding-left: 40px;"><tt>rotation</tt></td><td>JSON object</td><td align=center>mandatory</td><td></td>
<td>Quaternion coordinates of joint rotation relative to parent joint.</td></tr>
<tr><td style="padding-left: 80px;"><tt>w</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>w cooordinate.</td></tr>
<tr><td style="padding-left: 80px;"><tt>x</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>x cooordinate.</td></tr>
<tr><td style="padding-left: 80px;"><tt>y</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>y cooordinate.</td></tr>
<tr><td style="padding-left: 80px;"><tt>z</tt></td><td>number</td><td align=center>Double</td><td></td>
<td>z cooordinate.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "refit-pose"
}

// Response
{
"success": true
}

// Event
{
"event": "refit-pose-finished",
"arguments":
{
"mismatch": -0.0346799499867484,
"translation":
{
"x": 0.20735317468643188,
"y": 0.93647444248199463,
"z": 0.1268109530210495
},
"joints":
[
{
"name": "Hip",
"rotation":
{
"w": 0.99089264869689941,
"x": -0.024765072390437126,
"y": -0.13141168653964996,
"z": -0.015792140737175941
}
},
{
"name": "LowerSpine",
"rotation":
{
"w": 0.9960486888885498,
"x": 0.028381859883666039,
"y": -0.083706416189670563,
"z": -0.008648967370390892
}
},
{
"name": "MiddleSpine",
"rotation":
{
"w": 0.9960486888885498,
"x": 0.028381859883666039,
"y": -0.083706416189670563,
"z": -0.008648967370390892
}
},
{
"name": "Chest",
"rotation":
{
"w": 0.9960486888885498,
"x": 0.028381859883666039,
"y": -0.083706416189670563,
"z": -0.008648967370390892
}
},
{
"name": "Neck",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "Head",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "EffectorHead",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "LClavicle",
"rotation":
{
"w": 0.99793654680252075,
"x": 0.0059945755638182163,
"y": 0.046108484268188477,
"z": 0.044281467795372009
}
},
{
"name": "LShoulder",
"rotation":
{
"w": 0.9549943208694458,
"x": -0.034553475677967072,
"y": 0.29447850584983826,
"z": 0.0086394213140010834
}
},
{
"name": "LForearm",
"rotation":
{
"w": 0.91743868589401245,
"x": -0.036340668797492981,
"y": -0.39591813087463379,
"z": 0.015319216065108776
}
},
{
"name": "LHand",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "RClavicle",
"rotation":
{
"w": 0.995156466960907,
"x": -0.040068801492452621,
"y": -0.048379208892583847,
"z": 0.075615249574184418
}
},
{
"name": "RShoulder",
"rotation":
{
"w": 0.965262770652771,
"x": -0.0052053602412343025,
"y": 0.26098120212554932,
"z": -0.011395715177059174
}
},
{
"name": "RForearm",
"rotation":
{
"w": 0.99951714277267456,
"x": -0.020441532135009766,
"y": -0.0027645230293273926,
"z": -0.023236606270074844
}
},
{
"name": "RHand",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "RThigh",
"rotation":
{
"w": 0.79308795928955078,
"x": 0.068257540464401245,
"y": 0.60094189643859863,
"z": 0.072259068489074707
}
},
{
"name": "RShin",
"rotation":
{
"w": 0.79541802406311035,
"x": 0.053630385547876358,
"y": 0.60230922698974609,
"z": -0.040715586394071579
}
},
{
"name": "RFoot",
"rotation":
{
"w": 0.99298214912414551,
"x": -0.11810562759637833,
"y": -0.00553984334692359,
"z": -0.0026492751203477383
}
},
{
"name": "RToe",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "EffectorRToe",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "LThigh",
"rotation":
{
"w": 0.99825394153594971,
"x": -0.0010303414892405272,
"y": 0.021972890943288803,
"z": 0.054818056523799896
}
},
{
"name": "LShin",
"rotation":
{
"w": 0.99794912338256836,
"x": 0.059693548828363419,
"y": 0.023080151528120041,
"z": -0.0013148610014468431
}
},
{
"name": "LFoot",
"rotation":
{
"w": 0.98020839691162109,
"x": -0.18852591514587402,
"y": -0.054500121623277664,
"z": -0.026062563061714172
}
},
{
"name": "LToe",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
},
{
"name": "EffectorLToe",
"rotation":
{
"w": 1.0,
"x": 0.0,
"y": 0.0,
"z": 0.0
}
}
]
}
}
</syntaxhighlight>

==== get-pose-mismatch ====

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>mismatch</tt></td><td>number</td><td align=center>mandatory</td><td>Negative double</td>
<td>Current pose mismatch.</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-pose-mismatch"
}

// Response
{
"success": true,
"result":
{
"mismatch": -0.036337155848741531
}
}
</syntaxhighlight>

==== delete-pose ====

''delete-pose'' deleted pose in current frame.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "delete-pose"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== track-forward ====

''track-forward'' starts tracking forward.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>trackingKind</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected tracking kind menu item.<br><tt>0</tt> - ''iPi + AI (Default)''<br><tt>1</tt> - ''AI-based Only''<br><tt>2</tt> - ''Auto-Fix Pose (AI-based)''</td>
<td>Selected tracking kind.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''tracking-operation-finished''' event is generated when tracking is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "track-forward",
"arguments":
{
"trackingKind": 0
}
}

// Response
{
"success": true
}

// Event
{
"event": "tracking-operation-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}

</syntaxhighlight>

==== track-backward ====

''track-backward'' starts tracking backward.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>trackingKind</tt></td><td>number</td><td align=center>optional</td>
<td>Integer index of selected tracking kind menu item.<br><tt>0</tt> - ''iPi + AI (Default)''<br><tt>1</tt> - ''AI-based Only''<br><tt>2</tt> - ''Auto-Fix Pose (AI-based)''</td>
<td>Selected tracking kind.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''tracking-operation-finished''' event is generated when tracking is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "track-backward",
"arguments":
{
"trackingKind": 0
}
}

// Response
{
"success": true
}

// Event
{
"event": "tracking-operation-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}
</syntaxhighlight>

==== refine-forward ====

''refine-forward'' starts refine forward.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''tracking-operation-finished''' event is generated when tracking is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "refine-forward"
}

// Response
{
"success": true
}

// Event
{
"event": "tracking-operation-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}
</syntaxhighlight>

==== refine-backward ====

''refine-backward'' starts refine backward.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''tracking-operation-finished''' event is generated when tracking is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "refine-backward"
}

// Response
{
"success": true
}

// Event
{
"event": "tracking-operation-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}
</syntaxhighlight>

==== pause-tracking ====

''pause-tracking'' stops tracking or refine operation.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "pause-tracking"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== remove-jitter ====

''remove-jitter'' starts jitter removal.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''tracking-operation-finished''' event is generated when jitter removal is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "remove-jitter"
}

// Response
{
"success": true
}

// Event
{
"event": "tracking-operation-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}
</syntaxhighlight>

=== Live (Real-Time) Session Commands ===

These commands control [[Real-time Tracking for Live Preview|real-time tracking]] function.

==== start-live-session ====

''start-live-session'' starts live (real-time) session.
You can set desired tracking options using [[#set-tracking-props|set-tracking-props]] command after starting a session but before connecting to live sources with [[#connect-to-live-sources|connect-to-live-sources]].

{{Note|Before live session is started a previously open project is closed automatically.}}

{{AutomationPrimitiveCommand|start-live-session}}

==== end-live-session ====

''end-live-session'' ends live (real-time) session.

{{AutomationPrimitiveCommand|end-live-session}}

==== discover-live-sources ====

''discover-live-sources'' finds hosts on the network which run compatible versions of [[iPi Recorder]] in [[Real-time Tracking for Live Preview#Recording|broadcast mode]]. Should be executed while in live session.

{{AutomationCommandParams
|args=
{{AutomationCommandParam|name=timeout|values=Time span value in format '''hh:mm:ss[.sssssss]'''|desc=
Time to wait for live sources to be discovered. Default value is 5 seconds.}}
|result=
{{AutomationCommandSimpleResult|Array of host names running available live sources.}}
}}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "discover-live-sources",
"arguments":
{
"timeout": "0:0:2" // 2 seconds
}
}

// Response
{
"success": true,
"result": ["PC-MIKE"]
}
</syntaxhighlight>

==== connect-to-live-sources ====

''connect-live-sources'' establishes a connection to available or specified hosts and start real-time tracking. Should be executed while in live session.

{{AutomationCommandParams
|args=
{{AutomationCommandParam|name=hostNames|type=array|values=String array.|desc=
Names of hosts to connect to. If omitted, all available hosts will be used. If some of specified hosts cannot be connected the command will fail.}}
{{AutomationCommandParam|name=timeout|values=Time span in format '''hh:mm:ss'''.|desc=
Timeout to establish a connection. Default value is 5 seconds.}}
|result=
{{AutomationCommandSimpleResult|Array of host names to which a connection has been established.}}
}}

''EXAMPLE''
<syntaxhighlight lang=javascript>
// Request
{
"command": "connect-to-live-sources",
"arguments":
{
"hostNames": ["PC-MIKE"],
"timeout": "0:0:2" // 2 seconds
}
}

// Response
{
"success": true,
"result": ["PC-MIKE"]
}
</syntaxhighlight>

==== disconnect-from-live-sources ====

''disconnect-from-live-sources'' stops real-time tracking and disconnects from hosts. Should be executed while connected.

{{AutomationPrimitiveCommand|disconnect-from-live-sources}}

==== start-live-recording ====

''start-live-recording'' starts recording real-time tracking data to a project file. Should be executed while connected.

{{AutomationCommandParams
|args=
{{AutomationCommandParam|name=projectPath|values=Valid file path.|desc=
Path to a project file for recording. Prefer absolute path to avoid unintended location. If omitted then a value currently set in UI will be used.}}
|result=
{{AutomationCommandParam|name=projectPath|usage=mandatory|desc=
Actual project path used.}}
}}

''EXAMPLE''
<syntaxhighlight lang=javascript>
// Request
{
"command": "start-live-recording",
"arguments":
{
"projectPath": "D:\\iPiMocap\\test.iPiMocap"
}
}

// Response
{
"success": true,
"result":
{
"projectPath": "D:\\iPiMocap\\test.iPiMocap"
}
}
</syntaxhighlight>

==== stop-live-recording ====

''stop-live-recording'' stops recording real-time data. Should be executed while recording.

{{AutomationCommandParams
|result=
{{AutomationCommandParam|name=projectPath|usage=mandatory|desc=Path of the recorded project.}}
{{AutomationCommandParam|name=frameCount|type=integer|usage=mandatory|desc=Number of frames recorded.}}
{{AutomationCommandParam|name=duration|usage=mandatory|values=Timespan in format '''hh:mm:ss.ffffff'''.|desc=Duration of recording.}}
}}

''EXAMPLE''
<syntaxhighlight lang=javascript>
// Request
{
"command": "stop-live-recording"
}

// Response
{
"success": true,
"result":
{
"projectPath": "D:\\iPiMocap\\test.iPiMocap",
"frameCount": 900,
"duration": "00:00:30.000000"
}
}
</syntaxhighlight>

=== Biomech Commands ===

==== load-biomech-profile ====

''load-biomech-profile'' loads biomech profile from ''.iPiBiomech'' file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>profilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "load-biomech-profile",
"arguments":
{
"profilePath": "D:\\iPiMocap\\test.iPiBiomech"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== plot-biomech-data ====

''plot-biomech-data'' plots biomech data.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "plot-biomech-data"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== export-biomech-data ====

''export-biomech-data'' exports bones motion data to file or copies to clipboard.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>format</tt></td><td>string</td><td align=center>mandatory</td><td><tt>text<br>matlab<br>clipboard</tt></td>
<td>Export format.
</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Full path to file. Not needed in case of copying to clipboard.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''biomech-data-export-completed''' event is generated when export is competed </td></tr>
<tr><td colspan="5">''No event arguments''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "export-biomech-data",
"arguments":
{
"format": "text",
"filePath": "D:\\iPiMocap\\test.txt"
}
}

// Response
{
"success": true
}

// Event
{
"event": "biomech-data-export-completed",
"arguments":
{
"success": true
}
}
</syntaxhighlight>

==== export-point-cloud ====

''export-point-cloud'' exports point cloud data to file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>format</tt></td><td>string</td><td align=center>mandatory</td><td><tt>pcd<br>obj<br>matlab<br>ply<br>pts<br>prt<br>xyz</tt></td>
<td>Export format.</td></tr>
<tr><td><tt>folderPath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid folder path</td>
<td>Full path to folder to export to.</td></tr>
<tr><td><tt>fileName</tt></td><td>string</td><td align=center>mandatory</td><td>File name</td>
<td>File name (does not include path to folder but includes extension).</td></tr>
<tr><td><tt>subtractBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Subtract background flag value.</td></tr>
<tr><td><tt>subtractBackgroundThreshold</tt></td><td>numeric</td><td align=center>optional</td><td>Double from -4 to 5</td>
<td>Background subtraction threshold. Bigger value means more points will be subtracted.</td></tr>
<tr><td><tt>exportRGB</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Export RGB information flag value.</td></tr>
<tr><td><tt>currentFrameOnly</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>If <tt>true</tt>, only current frame will be exported.<br>If <tt>false</tt>, all frames of Region-of-Interest will be exported.</td></tr>
<tr><td><tt>cameraIndises</tt></td><td>numeric array</td><td align=center>optional</td><td></td>
<td>Array of camera indicese (starting from 0) to include in export. If not set, all cameras will be exported.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''point-cloud-export-finished''' event is generated when point cloud export is competed or cancelled</td></tr>
<tr><td><tt>framesProcessed</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of frames processed. In case of successful completion equal to '''Region-of-Interest''' number of frames.</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "export-point-cloud",
"arguments":
{
"format": "pcd",
"folderPath": "D:\\iPiMocap",
"fileName": "test.pcd",
"subtractBackground": true,
"exportRGB": true
}
}

// Response
{
"success": true
}

// Event
{
"event": "point-cloud-export-finished",
"arguments":
{
"framesProcessed": 253,
"elapsedTime": 62.321,
"fps": 4.05963,
}
}
</syntaxhighlight>

=== Calibration Commands ===

==== run-calibration ====

''run-calibration'' starts calibration.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>markerSpotSize</tt></td><td>string</td><td align=center>optional</td><td><tt>small<br>medium<br>large</tt></td>
<td>Marker spot size on video setting.</td></tr>
<tr><td><tt>markerColor</tt></td><td>string</td><td align=center>optional</td><td>Valid html color value</td>
<td>Marker color setting.</td></tr>
<tr><td><tt>autoDetectInitialCameraPositions</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Auto detect initial camera positions flag value. RGB projects only.</td></tr>
<tr><td><tt>autoAdjustFov</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Auto adjust FOV flag value. RGB projects only.</td></tr>
<tr><td><tt>calibrationMode</tt></td><td>string</td><td align=center>optional</td><td><tt>fast<br>normal<br>extended<br>extreme</tt></td>
<td>Calibration mode. RGB projects only.</td></tr>
<tr><td><tt>board</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Depth projects only. Set this flag to <tt>true</tt> for running calibration with board. Other parameters are not applicable in this case.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''calibration-finished''' event is generated when point cloud export is competed or canceled</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>canceled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Set to <tt>true</tt> if calibration was canceled by user.</td></tr>
<tr><td><tt>rgbCalibrationStat</tt></td><td>JSON objects array</td><td align=center>optional</td><td></td>
<td>List of calibration statistics per camera for RBG projects.</td></tr>
<tr><td style="padding-left: 40px;"><tt>quality</tt></td><td>string</td><td align=center>mandatory</td><td><tt>failed<br>good<br>perfect<br>unknown</tt></td>
<td>Camera calibration quality.</td></tr>
<tr><td style="padding-left: 40px;"><tt>reprojectionError</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Camera reprojection error.</td></tr>
<tr><td style="padding-left: 40px;"><tt>mistetects</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Camera misdetects percent.</td></tr>
<tr><td><tt>depthMarkerCalibrationStat</tt></td><td>JSON object</td><td align=center>optional</td><td></td>
<td>Calibration statistics for depth projects calibrated with flashlight.</td></tr>
<tr><td style="padding-left: 40px;"><tt>quality</tt></td><td>string</td><td align=center>mandatory</td><td><tt>failed<br>good<br>perfect<br>unknown</tt></td>
<td>Camera calibration quality.</td></tr>
<tr><td style="padding-left: 40px;"><tt>goodFramesCount</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of good frames.</td></tr>
<tr><td style="padding-left: 40px;"><tt>averagePositionError</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average position error.</td></tr>
<tr><td style="padding-left: 40px;"><tt>markerCloudMinSize</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Marker point cloud minimum size.</td></tr>
<tr><td style="padding-left: 40px;"><tt>occlusionPercent</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Occlusion percent.</td></tr>
<tr><td><tt>depthBoardCalibrationStat</tt></td><td>JSON object</td><td align=center>optional</td><td></td>
<td>Calibration statistics for depth projects calibrated with board.</td></tr>
<tr><td style="padding-left: 40px;"><tt>quality</tt></td><td>string</td><td align=center>mandatory</td><td><tt>failed<br>good<br>perfect<br>unknown</tt></td>
<td>Camera calibration quality.</td></tr>
<tr><td style="padding-left: 40px;"><tt>goodFramesCount</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of good frames.</td></tr>
<tr><td style="padding-left: 40px;"><tt>averageAngleError</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average angle error.</td></tr>
<tr><td style="padding-left: 40px;"><tt>averagePositionError</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average position error.</td></tr>
<tr><td colspan="5">'''progress-updated''' event is generated every 1 second while operation is running</td></tr>
<tr><td><tt>elapsedTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Total processing time in seconds.</td></tr>
<tr><td><tt>remainingTime</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Remaining time in seconds.</td></tr>
<tr><td><tt>progress</tt></td><td>number</td><td align=center>mandatory</td><td>Double within <tt>[0,1]</tt> range</td>
<td>Progress estimation. <tt>1</tt> means 100%.</td></tr>
<tr><td><tt>fps</tt></td><td>number</td><td align=center>mandatory</td><td>Double</td>
<td>Average processing speed in frames per second.</td></tr></table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "run-calibration",
"arguments":
{
"markerSpotSize": "large",
"markerColor": "#0099FF",
"calibrationMode": "fast"
}
}

// Response
{
"success": true
}

// Event
{
"event": "calibration-finished",
"arguments":
{
"elapsedTime": 49.0548727,
"canceled": false,
"rgbCalibrationStat":
[
{
"quality": "perfect",
"reprojectionError": 0.8999624,
"misdetects": 0.36743924
},
{
"quality": "perfect",
"reprojectionError": 0.5540145,
"misdetects": 0.328137815
},
{
"quality": "perfect",
"reprojectionError": 0.8146306,
"misdetects": 0.5209761
},
{
"quality": "perfect",
"reprojectionError": 0.567752242,
"misdetects": 1.13636363
}
]
}
}

// Event
{
"event": "progress-updated",
"arguments":
{
"elapsedTime": 5.3501876,
"remainingTime": 0.80599999999999994,
"progress":0.86486486486486491,
"fps":6.169
}
}

</syntaxhighlight>

==== mark-ground-points ====

''mark-ground-points'' marks ground points.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>frames</tt></td><td>numeric array</td><td align=center>mandatory</td><td></td>
<td>List of frame indices to be marked as ground</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>

</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "mark-ground-points",
"arguments":
{
"frames": [28, 304, 504, 1123]
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== ummark-ground-points ====

''unmark-ground-points'' unmarks ground points.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>frames</tt></td><td>numeric array</td><td align=center>optional</td><td></td>
<td>List of ground points frame indices to be unmarked. Unmarks all ground points if empty.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>

</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "unmark-ground-points",
"arguments":
{
"frames": [28, 304, 504, 1123]
}
}

// Response
{
"success": true
}
</syntaxhighlight>

=== Animation Export Commands ===

==== load-target-character ====

''load-target-character'' loads target character from file or selects from predefined characters list.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>rigName</tt></td><td>string</td><td align=center>optional</td><td><tt>default<br>motionbuilder<br>3dsmax<br>endorphin<br>iclone<br>blender</tt></td>
<td>Name of predefined rig.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path</td>
<td>Full path to character file.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "load-target-character",
"arguments":
{
"rigName": "3dsmax"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== load-motion-transfer-profile ====

''load-motion-transfer-profile'' loads motion transfer profile from ''.iPiTransfer'' file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>profilePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "load-motion-transfer-profile",
"arguments":
{
"profilePath": "D:\\iPiMocap\\test.iPiTransfer"
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== get-export-props ====

''get-export-props'' command gets export properties.

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>advancedMotionTransfer</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Advanced motion transfer flag value.
</td></tr>
<tr><td><tt>recenterCoordinateSystemOnCharacter</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Recenter coordinate system on character flag value.
</td></tr>
<tr><td><tt>exportTPoseInFirstFrame</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Export T-Pose in first frame flag value.
</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "get-export-props"
}

// Response
{
"success": true,
"result":
{
"advancedMotionTransfer": true,
"recenterCoordinateSystemOnCharacter": false,
"exportTPoseInFirstFrame": true,
}
}
</syntaxhighlight>

==== set-export-props ====

''set-export-props'' command sets export properties.

{{Tip|If property is not specified in command arguments, current value in user interface will be used. }}

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>advancedMotionTransfer</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Advanced motion transfer flag value.
</td></tr>
<tr><td><tt>recenterCoordinateSystemOnCharacter</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Recenter coordinate system on character flag value.
</td></tr>
<tr><td><tt>exportTPoseInFirstFrame</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Export T-Pose in first frame flag value.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "set-export-props",
"arguments":
{
"advancedMotionTransfer": true,
"recenterCoordinateSystemOnCharacter": false,
"exportTPoseInFirstFrame": true,
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== export-animation ====

''export-animation'' exports animation to file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path to file. Animation format is defined by file extension.
</td></tr>
<tr><td><tt>fbxIsBinary</tt></td><td>string</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Fbx binary format flag for FBX format. If <tt>false</tt> or not set, ASCII format is used.
</td></tr>
<tr><td><tt>fbxVersion</tt></td><td>string</td><td align=center>optional</td><td><tt>2014<br>2013<br>2012<br>2011<br>2010</tt></td>
<td>Fbx version for FBX format.
</td></tr>
<tr><td><tt>exportCameras</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt></td>
<td>Whether to include camera positions to an animation file.<br/>Default is <tt>false</tt>.
</td></tr>
<tr><td><tt>targetFrameRate</tt></td><td>integer</td><td align=center>optional</td><td>Positive value</td>
<td>Target frame rate for exported animation. When omitted, frame rate of a source iPiVideo file is used.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "export-animation",
"arguments":
{
"filePath": "D:\\iPiMocap\\test.bvh",
"targetFrameRate": 30
}
}

// Response
{
"success": true
}
</syntaxhighlight>

==== start-streaming-animation ====

''start-streaming-animation'' starts [[Streaming to Unity|streaming pose data]] to a network.

{{AutomationCommandParams|args=
{{AutomationCommandParam|name=port|type=integer|values=Positive value|desc=
UDP port for streaming. If omitted, the currently set value is used.}}
}}

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
"command": "start-streaming-animation"
}

// Response
{
"success": true
}
</syntaxhighlight>

==== stop-streaming-animation ====

''stop-streaming-animation'' stops [[Streaming to Unity|streaming pose data]] to a network.

{{AutomationPrimitiveCommand|stop-streaming-animation}}

Streaming to Unreal

2024-05-10T17:03:26Z

Pavel:

{{EditionFeature|Basic}}

iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor and integrate reading animation stream from [[iPi Mocap Studio]] into your games or applications created with Unreal.

==Usage in Mocap Studio==

{{:Animation Streaming In Mocap Studio}}

==Usage in Unreal==

To get data streamed by [[iPi Mocap Studio]] into Unreal Engine please follow instructions below.

1. Install '''iPi Mocap Live Link''' plugin:

1.1. Download '''iPi Mocap Live Link''' plugin via links below.

Download:<br>UE 5.4 - [https://files.ipisoft.com/iPiMocap-Unreal-5-4.zip iPiMocap-Unreal-5-4.zip]; UE 5.3 - [https://files.ipisoft.com/iPiMocap-Unreal-5-3.zip iPiMocap-Unreal-5-3.zip]; UE 5.2 - [https://files.ipisoft.com/iPiMocap-Unreal-5-2.zip iPiMocap-Unreal-5-2.zip]; UE 5.1 - [https://files.ipisoft.com/iPiMocap-Unreal-5-1.zip iPiMocap-Unreal-5-1.zip]; UE 5.0 - [https://files.ipisoft.com/iPiMocap-Unreal-5-0.zip iPiMocap-Unreal-5-0.zip];<br>UE 4.27 - [https://files.ipisoft.com/iPiMocap-Unreal-4-27.zip iPiMocap-Unreal-4-27.zip]; UE 4.26 - [https://files.ipisoft.com/iPiMocap-Unreal-4-26.zip iPiMocap-Unreal-4-26.zip]; UE 4.25 - [https://files.ipisoft.com/iPiMocap-Unreal-4-25.zip iPiMocap-Unreal-4-25.zip]; UE 4.24 - [https://files.ipisoft.com/iPiMocap-Unreal-4-24.zip iPiMocap-Unreal-4-24.zip]

1.2. Unpack downloaded archieve into ''Engine\Plugins'' folder of your Unreal Engine installation. The folder ''iPiSoft'' will be created with subfolder ''iPiMocapLiveLink'' that will contain the plugin binaries and source code.

2. You will then have to activate installed plugin in your project.

2.1. (Re)start the Unreal Editor.

2.2. Open '''Plugins''' window via ''Edit > Plugins'' menu. Select ''Animation'' category.

2.3. Enable '''iPi Mocap Live Link''' and '''Live Link''' plugins.

2.4. Restart the editor by pressing '''Restart Now''' button.

[[File:UE-Enable-Plugin-Screen-1.png|center]]

3. Installed plugin will provide ''iPi Mocap Live Link'' source you can use to get animation data from '''iPi Mocap Studio'''. You can further use standard '''Live Link''' features to apply animation data to your character.

===Instuctions for quick test.===

====MetaHuman====
We used [https://www.unrealengine.com/marketplace/en-US/learn/metahumans MetaHumans] project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''MetaHuman'' rig.

[[File:UE-Start-Streaming-4.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate MetaHuman character. Feed in output of ''Live Link Pose'' into ''Control Rig'' component in ''m_med_nnw_animbp''. You can find it in ''Content > SampleMetaHumans > metahuman_004 > Male > Medium > NormalWeight > Body'' folder for male character or ''Content > SampleMetaHumans > metahuman_001 > Female > Medium > NormalWeight > Body'' for female character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-MetaHuman-Feed-In-Pose-Data.png|center|800px]]

====UE4 Mannequin (Standard Unreal Character)====
We used ''ThirdPerson'' project template.

* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''UE4 Mannequin'' rig if you use standard Unreal character. You can import your own rig into '''iPi Mocap Studio''' and setup motion transfer profile if you use custom rig.

[[File:UE-Start-Streaming-1.png|center]]

* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item ('''Window > Virtual Production > Live Link''' in UE5).

[[File:UE-Open-LiveLink-Manager.png|center]]

* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.

:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}

<center>
{|
|[[File:UE-Connect-2.png|center]]
|[[File:UE-Connected-2.png|center]]
|}
</center>

* You can then use ''Live Link Pose'' blueprint to animate your character.

:{{Note|Don't forget to select ''Character'' Live Link subject to feed in animation data.}}

:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}

[[File:UE-Animated.png|center|800px]]

iPi Mocap Studio Release Notes

2024-04-03T14:59:18Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.263.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] featue added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
* Project recording with [[Real-time Tracking for Live Preview]] could not open.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

iPi Mocap Studio Release Notes

2024-04-03T14:55:44Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.3.265|Apr 03, 2024|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.3.263.exe}}

 N E W    F E A T U R E S:
* AI-based [[AI-based Tracking#Tracking with Auto-recover option|Tracking with Auto-recover option]] featue added. It allows to automatically detect and fix tracking errors with the help of AI-based tracking.
 B U G    F I X E S:
* Rare AI-based tracking crashes in some cases.
* Fixed crashing on project closing when Pose Mismatch view mode is on.
 U N D E R    T H E    H O O D:
* AI pose interpolation/filters are only applied if AI attempted to apply in this frame.

{{VersionShortInfo|4.6.2.264|Dec 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263|Nov 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

File:tracking-ai-auto-recover-2.png

2024-04-03T14:36:51Z

Pavel:

AI-based Tracking

2024-04-03T14:36:39Z

Pavel:

== Introduction ==

Starting from version '''4.6.0''' the [[iPi Mocap Studio]] offers new features that are based on integration with 3<sup>rd</sup> party AI (artificial intelligence) libraries like [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR SDK].

These features are marked as '''"AI-based"''' or simply '''"(AI)"''' on UI and aimed to help with auxiliary tasks like:
* detect initial actor pose
* automatically fix tracking errors
* track feet, hands and head rotations

== System Requirements ==

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>OS</th><td>MS Windows 10 or 11 64-bit</td></tr>
<tr><th>RAM</th><td>8GB or higher</td></tr>
<tr><th>GPU</th><td>NVIDIA RTX 20/30/40 Series, or NVIDIA Quadro RTX or NVIDIA RTX professional GPUs</td></tr>
<tr><th>DRIVER</th><td>NVIDIA Display Driver version 520.46 or higher</td></tr>
</table>

''If your system is not compatible, you can hide all new UI elements that requires AI libraries via '''Hide all AI-based Features on UI''' checkbox in '''Backward Compatibility''' collapsible group box on '''Tracking''' tab:''
<center>[[File:hide-all-ai-based-features.png]]</center>

== 3rd Party Libraries Installation ==

To be able to use AI-based features, you should download and install [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime on your own. It can be done either by downloading appropriate version of AR 0.8.2 runtime from the following page [https://www.nvidia.com/broadcast-sdk-resources], or via the following dialog automatically shown by [[iPi Mocap Studio]] when AI-based detectors are required but [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime cannot be found in the system:

<center>[[File:maxine-ar-0 8 2-required-dlg.png]]</center>

== Limitations of Current Version ==

Currently, AI-based features are only available for the following types of projects/videos:
* Multi camera RGB video, single actor
* Single or multi depth sensor video with color data, single actor

''That is, if your project contains multiple actors or it is recorded with the aid of depth sensor(s) without color data (only depth maps, no RGB images) then you are unable to use new AI-based features. Support for multiple actors will be added in future versions.''

== How to Use ==

=== Detect Pose (AI) ===

This feature is available on two Tabs: '''Actor''' and '''Tracking'''.

<center><table border="0">
<tr><td>[[File:actor-detect-pose-ai.png]]</td><td>  </td><td>[[File:tracking-detect-pose-ai.png]]</td></tr>
</table></center>

In both cases, AI pose detector is applied to all available RGB images in the current frame, after that detection results are combined from all cameras, post-processed and Inverse Kinematics (IK) is used to produce pose of 3D character. This functionality is very useful to set initial pose before tracking or to fix tracking errors.

{{Tip|You can visualize raw output of AI detector for each camera by selecting '''View > Raw AI Skeleton''' item in the main menu. ''Raw AI Skeleton'' is shown as green balls connected with yellow sticks. Switch between cameras to see results for each camera.}}

<center>[[File:view-raw-ai-skeleton.png]]</center>

After that, you can apply Refit Pose in most cases to refine 3D character position based on iPi proprietary tracking algorithms. However, please remember that correct actor parameters must be specified before using of Refit Pose.

=== Detect Pose and Height (AI) ===

'''Detect Pose and Height (AI)''' is available on '''Actor''' tab as an item in drop-down menu under '''Auto Adjust Actor Pose''' button. This feature works similar to the previous one but in addition to pose detection, it estimates actor’s height. The accuracy of such detection depends on pose, cameras views, etc. In most cases, it is better to set height manually if you know it. However, you can give it a try and see if it works for you.

<center>[[File:actor-detect-pose-and-height-ai.png]]</center>

=== AI-based feet tracking ===

Now there are three options for feet tracking:
# '''Do not track'''. Feet are not tracked and have default position (zero rotation) in all frames. Corresponds to unchecked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track'''. Proprietary iPi algorithms are used to track feet. Corresponds to checked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track (AI-based)'''. AI detectors are used to determine feet positions in each frame during tracking pass. First introduced in version '''4.6.0.'''

''In some cases, iPi proprietary algorithms work better for feet, but for other videos AI-based tracking can be really useful.''

<center><table border="0">
<tr><td>[[File:tracking-settings-feet_4_6_0.png]]</td><td>  </td><td>[[File:tracking-settings-feet_4_5_8.png]]</td></tr>
<tr><th>v.4.6.0</th><th></th><th>v.4.5.8</th></tr>
</table></center>

{{Tip|AI-based tracking is very noisy. For this reason, please do not forget to apply aggressive [[Automatic_Refinement_and_Filtering|Jitter Removal]] for body parts tracked with the help of AI.}}

=== AI-based head tracking ===

Similar to feet tracking, head position can be tracked with the aid of iPi proprietary algorithms or based on AI detectors. Again, for some videos (especially depth ones) AI-based approach can be more accurate.

=== AI-based hands tracking ===

In addition to feet and head, AI-based tracking can be applied to hands. Currently, only rotations for hands is supported. Neither thumb nor fingers positions are tracked. Use [[Hand_Keyframing|key framing]] for fingers, as before. In addition, accuracy of hands rotations determined by AI-based algorithms depends on hands visibility in cameras.

<center>[[File:tracking-settings-hands-ai.png]]</center>

=== Applying only AI-based tracking ===

When one chooses AI-based tracking for Head/Hands/Feet, it applies during standard Tracking Forward / Backward pass along with iPi incremental tracking for full body. But when tracking has already been performed and there is no need to re-track frames in ROI, one can apply only AI-based tracking for Head/Hands/Feet (depending on selected settings for them). To do it, click on down arrow in the right part of '''Track Forward/Backward''' buttons and choose '''AI-based Only''' item in drop-down menu. This could be helpful during experiments with different AI options because it allows applying changes fast.

<center>[[File:tracking-ai-based-only.png]]</center>

{{Note|If AI-based tracking is not selected for any body part, or tracking is turned off for all individual body parts that requires AI-based tracking, then '''AI-based Only''' option is not available in the drop-down menu.}}

=== Automatic tracking errors fixing ===

AI-based pose detection can help fixing tracking errors:
* Choose frame with erroneous pose after tracking
* Click '''Detect Pose (AI)''' button to set pose roughly based on AI detectors
* Then click '''Refit Pose''' button to refine detected pose

In most cases, it should fix pose in the selected frame. But what if there are many sequential frames with erroneous poses? First, it is worth to try re-tracking in different direction from the fixed pose. It could help. If not then new '''Auto Fix Pose (AI-based)''' tracking option should be applied.

<center>[[File:tracking-auto-fix-pose-ai.png]]</center>

This option applies '''Detect Pose (AI)''' followed by '''Refit Pose''' actions for each frame in Forward/Backward directions, starting from the current frame.

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}

=== Tracking with Auto-recover option ===

This feature is more intellectual implementation of [[#Automatic tracking errors fixing]].
It is regularly compares the result of standard tracking with tracking that uses AI-detected pose as initial guess. If AI-based result is better, it uses it in the current frame and retacks back until it can improve tracking result. So if tracking error occurs, it is automatically detected, and misdetected frames are fixed. In most cases, this provides better tracking result and allows to avoid propagation of tracking errors to the subsequent frames.

How to track with Auto-Recover option:
* Just select '''Algorithm''' option
** Fast with Auto-recover (AI-based)
** or Standard with Auto-recover (AI-based)

Additional time is required to compare with AI-based result and re-tracking, but this may save a lot of time as you would not need manual error fixing.

<center>[[File:tracking-ai-auto-recover-2.png]]</center>

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}

File:tracking-ai-auto-recover-1.png

2024-04-03T14:22:15Z

Pavel:

AI-based Tracking

2024-04-03T14:17:45Z

Pavel:

== Introduction ==

Starting from version '''4.6.0''' the [[iPi Mocap Studio]] offers new features that are based on integration with 3<sup>rd</sup> party AI (artificial intelligence) libraries like [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR SDK].

These features are marked as '''"AI-based"''' or simply '''"(AI)"''' on UI and aimed to help with auxiliary tasks like:
* detect initial actor pose
* automatically fix tracking errors
* track feet, hands and head rotations

== System Requirements ==

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>OS</th><td>MS Windows 10 or 11 64-bit</td></tr>
<tr><th>RAM</th><td>8GB or higher</td></tr>
<tr><th>GPU</th><td>NVIDIA RTX 20/30/40 Series, or NVIDIA Quadro RTX or NVIDIA RTX professional GPUs</td></tr>
<tr><th>DRIVER</th><td>NVIDIA Display Driver version 520.46 or higher</td></tr>
</table>

''If your system is not compatible, you can hide all new UI elements that requires AI libraries via '''Hide all AI-based Features on UI''' checkbox in '''Backward Compatibility''' collapsible group box on '''Tracking''' tab:''
<center>[[File:hide-all-ai-based-features.png]]</center>

== 3rd Party Libraries Installation ==

To be able to use AI-based features, you should download and install [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime on your own. It can be done either by downloading appropriate version of AR 0.8.2 runtime from the following page [https://www.nvidia.com/broadcast-sdk-resources], or via the following dialog automatically shown by [[iPi Mocap Studio]] when AI-based detectors are required but [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime cannot be found in the system:

<center>[[File:maxine-ar-0 8 2-required-dlg.png]]</center>

== Limitations of Current Version ==

Currently, AI-based features are only available for the following types of projects/videos:
* Multi camera RGB video, single actor
* Single or multi depth sensor video with color data, single actor

''That is, if your project contains multiple actors or it is recorded with the aid of depth sensor(s) without color data (only depth maps, no RGB images) then you are unable to use new AI-based features. Support for multiple actors will be added in future versions.''

== How to Use ==

=== Detect Pose (AI) ===

This feature is available on two Tabs: '''Actor''' and '''Tracking'''.

<center><table border="0">
<tr><td>[[File:actor-detect-pose-ai.png]]</td><td>  </td><td>[[File:tracking-detect-pose-ai.png]]</td></tr>
</table></center>

In both cases, AI pose detector is applied to all available RGB images in the current frame, after that detection results are combined from all cameras, post-processed and Inverse Kinematics (IK) is used to produce pose of 3D character. This functionality is very useful to set initial pose before tracking or to fix tracking errors.

{{Tip|You can visualize raw output of AI detector for each camera by selecting '''View > Raw AI Skeleton''' item in the main menu. ''Raw AI Skeleton'' is shown as green balls connected with yellow sticks. Switch between cameras to see results for each camera.}}

<center>[[File:view-raw-ai-skeleton.png]]</center>

After that, you can apply Refit Pose in most cases to refine 3D character position based on iPi proprietary tracking algorithms. However, please remember that correct actor parameters must be specified before using of Refit Pose.

=== Detect Pose and Height (AI) ===

'''Detect Pose and Height (AI)''' is available on '''Actor''' tab as an item in drop-down menu under '''Auto Adjust Actor Pose''' button. This feature works similar to the previous one but in addition to pose detection, it estimates actor’s height. The accuracy of such detection depends on pose, cameras views, etc. In most cases, it is better to set height manually if you know it. However, you can give it a try and see if it works for you.

<center>[[File:actor-detect-pose-and-height-ai.png]]</center>

=== AI-based feet tracking ===

Now there are three options for feet tracking:
# '''Do not track'''. Feet are not tracked and have default position (zero rotation) in all frames. Corresponds to unchecked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track'''. Proprietary iPi algorithms are used to track feet. Corresponds to checked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track (AI-based)'''. AI detectors are used to determine feet positions in each frame during tracking pass. First introduced in version '''4.6.0.'''

''In some cases, iPi proprietary algorithms work better for feet, but for other videos AI-based tracking can be really useful.''

<center><table border="0">
<tr><td>[[File:tracking-settings-feet_4_6_0.png]]</td><td>  </td><td>[[File:tracking-settings-feet_4_5_8.png]]</td></tr>
<tr><th>v.4.6.0</th><th></th><th>v.4.5.8</th></tr>
</table></center>

{{Tip|AI-based tracking is very noisy. For this reason, please do not forget to apply aggressive [[Automatic_Refinement_and_Filtering|Jitter Removal]] for body parts tracked with the help of AI.}}

=== AI-based head tracking ===

Similar to feet tracking, head position can be tracked with the aid of iPi proprietary algorithms or based on AI detectors. Again, for some videos (especially depth ones) AI-based approach can be more accurate.

=== AI-based hands tracking ===

In addition to feet and head, AI-based tracking can be applied to hands. Currently, only rotations for hands is supported. Neither thumb nor fingers positions are tracked. Use [[Hand_Keyframing|key framing]] for fingers, as before. In addition, accuracy of hands rotations determined by AI-based algorithms depends on hands visibility in cameras.

<center>[[File:tracking-settings-hands-ai.png]]</center>

=== Applying only AI-based tracking ===

When one chooses AI-based tracking for Head/Hands/Feet, it applies during standard Tracking Forward / Backward pass along with iPi incremental tracking for full body. But when tracking has already been performed and there is no need to re-track frames in ROI, one can apply only AI-based tracking for Head/Hands/Feet (depending on selected settings for them). To do it, click on down arrow in the right part of '''Track Forward/Backward''' buttons and choose '''AI-based Only''' item in drop-down menu. This could be helpful during experiments with different AI options because it allows applying changes fast.

<center>[[File:tracking-ai-based-only.png]]</center>

{{Note|If AI-based tracking is not selected for any body part, or tracking is turned off for all individual body parts that requires AI-based tracking, then '''AI-based Only''' option is not available in the drop-down menu.}}

=== Automatic tracking errors fixing ===

AI-based pose detection can help fixing tracking errors:
* Choose frame with erroneous pose after tracking
* Click '''Detect Pose (AI)''' button to set pose roughly based on AI detectors
* Then click '''Refit Pose''' button to refine detected pose

In most cases, it should fix pose in the selected frame. But what if there are many sequential frames with erroneous poses? First, it is worth to try re-tracking in different direction from the fixed pose. It could help. If not then new '''Auto Fix Pose (AI-based)''' tracking option should be applied.

<center>[[File:tracking-auto-fix-pose-ai.png]]</center>

This option applies '''Detect Pose (AI)''' followed by '''Refit Pose''' actions for each frame in Forward/Backward directions, starting from the current frame.

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}

=== Tracking with Auto-recover option ===

This feature is more intellectual implementation of [[Automatic tracking errors fixing]].
It is regularly compares the result of standard tracking with tracking that uses AI-detected pose as initial guess. If AI-based result is better, it uses it in the current frame and retacks back until it can improve tracking result. So if tracking error occurs, it is automatically detected, and misdetected frames are fixed. In most cases, this provides better tracking result and allows to avoid propagation of tracking errors to the subsequent frames.

How to track with Auto-Recover option:
* Just select '''Algorithm''' option
** Fast with Auto-recover (AI-based)
** or Standard with Auto-recover (AI-based)

Additional time is required to compare with AI-based result and re-tracking, but this may save a lot of time as you would not need manual error fixing.

<center>[[File:tracking-ai-auto-recover-1.png]]</center>

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}

iPi Mocap Studio Release Notes

2023-12-25T15:54:34Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.2.264| 25, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.2.264.exe}}

 N E W    F E A T U R E S:
* Trajectory filtering for AI poses that improves overall [[AI-based Tracking]] quality.
* Interpolation of AI poses missed due to misdetections that improves overall [[AI-based Tracking]] quality.
{{Note|AI poses trajectory filtering and interpolation is auto-applied similar to regular trajectory filter.}}
 U N D E R    T H E    H O O D:
* Improved algorithm for selecting correct bounding box for AI pose tracking that improves overall [[AI-based Tracking]] quality.

{{VersionShortInfo|4.6.1.263| 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if '''Track''' or '''Track (AI-Based)''' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formerly set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

iPi Mocap Studio Release Notes

2023-11-07T09:55:08Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.1.263| 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if ''Track'' or ''Track (AI-Based)'' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formely set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies the Dnn tracking to take into account the possible changes of actor settings and/or ground plane.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

iPi Mocap Studio Release Notes

2023-11-07T09:35:39Z

Pavel:

<div style="color:#333333; border:dashed 1px gray; padding:4pt; margin:0.5em; background-color:#FAFAFA">
''Here you can find history of recent versions of [[iPi Mocap Studio]].''

''[[iPi Mocap Studio]] has built-in auto update functionality. Auto update feature is configured so that checks for update are made once per day. It helps to reduce the start time of the application. If you want to update ASAP — you can use the '''Help > Check for Update''' menu item.''

''Note that both of these features require Internet connection. Alternatively (in case of troubles with auto update), you can download and run the updated installation program from [https://files.ipisoft.com/iPiMocapStudioSetup.exe direct link].''
</div>

{{VersionShortInfo|4.6.1.263| 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.1.263.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] now sets head, feet poses and hands orientation if ''Track'' or ''Track (AI-Based)'' tracking option selected.
 E N H A N C E M E N T S:
* Improved quality of [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] for arms, legs and feet.
* Set realistic arm and leg twists in [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] (formely set zero twists).
* Ensure from enormous arm twists in jitter removal, [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]].
 B U G    F I X E S:
* Trajectory filtering was not applied after AI-based tracking.
* AI-based feet tracking sometimes returned invalid pose that led to crash.
* Rare crashes in trajectory filtering, jitter removal related to AI-based tracking.
 U N D E R    T H E    H O O D:
* All passes and jitter removal now process the last frame of Region-of-Interest (last frame inclusive).
* [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]] re-applies Dnn tracking to take into account possible actor settings, ground plane changes.

{{VersionShortInfo|4.6.0.262|Sep 06, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.6.0.262.exe}}

 N E W    F E A T U R E S:
* [[AI-based Tracking|New tracking features]] that use modern AI toolkit from NVIDIA:
** [[AI-based Tracking#Detect Pose (AI)|Detect Pose (AI)]]
** [[AI-based Tracking#Detect Pose and Height (AI)|Detect Pose and Height (AI)]]
** [[AI-based Tracking#AI-based feet tracking|AI-based feet tracking]]
** [[AI-based Tracking#AI-based head tracking|AI-based head tracking]]
** [[AI-based Tracking#AI-based hands tracking|AI-based hands tracking]]
** [[AI-based Tracking#Applying only AI-based tracking|Applying only AI-based tracking]]
** [[AI-based Tracking#Automatic tracking errors fixing|Automatic tracking errors fixing]]
* New build-in target characters and motion transfer profiles for better compatibility with Unreal Engine 5:
** UE5 Manny
** UE5 Quinn

[[File:release-notes-4 6 0.png|950px]]

 U N D E R    T H E    H O O D:
* Switching to [https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2020-2-1 FBX SDK 2020.2.1] for FBX files import/export
* Now Microsoft [https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 .Net Framework 4.8] is in use (was: 4.7.2)

{{VersionShortInfo|4.5.8.260|Apr 20, 2023|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.8.260.exe}}

 B U G    F I X E S:
* Fixed bug in Fast and Live tracking for multiple Azure Kinect depth sensors configuration.

{{VersionShortInfo|4.5.7.258|Jun 27, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.7.258.exe}}

 E N H A N C E M E N T S:
* Improvements in UI for editing of motion transfer profile.
** Check that no duplicate targets used when updating a symmetric bone mapping.
** Update a symmetric bone when adding/removing a target bone.
** Enabled the "(Unused)" item in the combo list.

 B U G    F I X E S:
* Fixes in editing of motion transfer profile.
** Fixed crash when trying to select an already used target bone in the viewport.
** Fixed inability to map symmetric bone when it can't be assigned automatically.
** Fixed an error when reading swing/twist weights from an XML file.

{{VersionShortInfo|4.5.6.256|Apr 18, 2022|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.6.256.exe}}

 N E W    F E A T U R E S:
* Support for Unreal Engine's MetaHuman character in animation export and streaming.
** [[Animation_Streaming#MetaHuman|Streaming animation to MetaHuman in Unreal Engine]].
** [[Animation_Export#Unreal_Engine|Motion transfer to MetaHuman character]].
* Motion transfer enhancements ([[Animation_Export#Multiple_Target_Bones|see details]]).
** Allow for multiple target bones in character mapping.
** Allow for separate swing and twist rotation channels.
* Added built-in motion transfer profile for Daz Genesis 8 character.
* Using separate swing and twist rotation channels in UE4 Mannequin, Endorphin built-in motion transfer profiles.

 B U G    F I X E S:
* Fixed animation streaming to Unreal that didn't work over network.

{{VersionShortInfo|4.5.2.252|Dec 02, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.2.252.exe}}

 E N H A N C E M E N T S:
* Speed of Jitter Removal algorithm substantially increased.
{{Note|The improved Jitter Removal algorithm now works on CPU. It can be 10-50 times faster depending on particular hardware, so we do not use progress indicator for it. The accuracy is the same.}}
* Replaced '''Use fast tracking algorithm''' checkbox on ''Tracking'' tab with '''Tracking algorithm''' combobox.

 B U G    F I X E S:
* Fixed tracking issues that led to tracking errors in rare cases.
* Fixed animation streaming crash in case of network failures.

{{VersionShortInfo|4.5.1.250|Jun 17, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe}}

 B U G    F I X E S:
* Fixed an issue with playback of some iPiVideo files recorded with PS Eye cameras (black image).
{{Tip|Those who use our Shell Extension for [[.iPiVideo File Extension|'''.iPiVideo''']] Files please reinstall iPi Mocap Studio using a [https://files.ipisoft.com/iPiMocapStudioSetup-4.5.1.250.exe full installer] to fix the extension as well.}}

{{VersionShortInfo|4.5.0.249|Jun 04, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.5.0.249.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded in '''Portrait''' and '''Upside down''' orientations.

{{VersionShortInfo|4.4.1.243|Feb 24, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.1.243.exe}}

 N E W    F E A T U R E S:
* Better support for Intel RealSense [https://www.intelrealsense.com/lidar-camera-l515/ L515] and [https://www.intelrealsense.com/depth-camera-d455/ D455] sensors.

 B U G    F I X E S:
* Fixed importing of target character from SMD file when bone names contain spaces.

{{VersionShortInfo|4.4.0.242|Feb 9, 2021|https://files.ipisoft.com/iPiMocapStudioSetup-4.4.0.242.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unreal Engine. For details see [[Streaming to Unreal]].
[[File:export-tab-streaming.png|300px]]

{{VersionShortInfo|4.3.1.240|Feb 28, 2020|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.1.240.exe}}

 N E W    F E A T U R E S:
* Added [[iPi Automation Add-on#Live (Real-Time) Session Commands|automation commands]] to control [[Real-time Tracking for Live Preview|real-time tracking]].
* Added [[iPi Automation Add-on#start-streaming-animation|automation commands]] to control [[Streaming to Unity|streaming of animation]] to a network.

 B U G    F I X E S:
* Fixed app crash during long live sessions.
* Fixed app crash when iPiVideo contains corrupted MJPEG frames.
* Fixed improper work of [[iPi Automation Add-on#load-target-character|load-target-character]] automation command with '''filePath''' argument.

{{VersionShortInfo|4.3.0.239|Oct 9, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.3.0.239.exe}}

 N E W    F E A T U R E S:
* '''Animation Streaming''' from [[iPi Mocap Studio]] to Unity. For details see [[Streaming to Unity]].
[[File:export-tab-streaming.png|300px]]
* Foot tracking improved for depth sensors.
* Distance between two arbitrary cameras can be controlled in Calibration projects for multiple RGB cameras (see table under '''Scale''' slider on '''Calibration''' tab).
* Improvements in [[Real-time Tracking for Live Preview]]:
** Significant progress in accuracy and stability.
** High/Low resolution setting.
** On the fly trajectory filtering (smoothing) during Live Preview.
** Restoring Live settings from the last session.
** Better visibility of point cloud during Live Preview.
** [[Streaming to Unity]] is available for Live Preview. Thus, one can see real-time live feedback right inside Unity.
:: {{Important|[[iPi Recorder]] 4.4.4 or later is required.}}

{{VersionShortInfo|4.2.0.235|Aug 23, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.2.0.235.exe}}

 N E W    F E A T U R E S:
* Support for videos recorded with '''Azure Kinect''' depth sensor.

 U N D E R    T H E    H O O D:
* Improved rendering smoothness during live tracking.
* Minor improvement in the quality of board calibration.

{{VersionShortInfo|4.1.3.233|May 16, 2019|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.3.233.exe}}

 N E W    F E A T U R E S:
* Built-in support for Unreal Engine 4 - compatible characters:
*# You can either import your character from FBX file in [[iPi Mocap Studio]]. If your character skeleton follows Unreal Mannequin structure and naming conventions, motion-transfer profile will be automatically generated. After that you just export animation in FBX format in [[iPi Mocap Studio]] and import it in Unreal Engine.
*#* {{Tip|This way is recommended because it works for all human-like characters regardless their proportions.}}
*# Or you can just choose '''UE4 Mannequin''' item from top part of '''Target character''' drop-down menu on '''Export''' tab in [[iPi Mocap Studio]], then you can export animation in FBX format and import result in Unreal Engine.
*#* {{Note|This way is usable only for characters with default Unreal Engine proportions.}}
* Selection from compatible motion transfer profiles when importing target character.
* New features in '''Motion Transfer Profile''':
** button to auto determine orientation of target character
** button to clear motion transfer profile
** slight redesign of controls layout
** improved tips

[[File:studio-transfer-profile-new-features-4-1-3.png|280px]]

 B U G    F I X E S:
* Accuracy issue in [https://en.wikipedia.org/wiki/Euler_angles Euler Angles] math (near [https://en.wikipedia.org/wiki/Gimbal_lock Gimbal Lock]). Results in minor short-term jitter of exported animation in some rare cases.
* Incorrect animation export for FBX models which have non-zero pre/post translation transformations for model node(s).
* Losing info about gyro sensors when opening project without a video.

 U N D E R    T H E    H O O D:
* Checking that primary GPU is not software emulation and is not '''Microsoft Basic Render Driver'''.
* Suppress adding to MRU list of target characters if animation was opened using '''Open Animation''' menu item.

{{VersionShortInfo|4.1.1.231|Dec 27, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.1.231.exe}}

 N E W    F E A T U R E S:
* Introduced ''Distribute rotation between Head and Neck'' setting for [[Motion_Controllers#Head_Rotation|Motion Controllers]].
* Support for Biomech export operations in [[Batch Processing]].

{{VersionShortInfo|4.1.0.230|Dec 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.1.0.230.exe}}

 N E W    F E A T U R E S:
* Support for multiple depth sensors in [[Real-time Tracking for Live Preview]]. Can be used in combination with [[Distributed Recording]].

 B U G    F I X E S:
* Twist angle over 180 degrees for hands, feet and head under certain condition.
* Minor bug fixes in [[Real-time Tracking for Live Preview]].

 U N D E R    T H E    H O O D:
* Based on users feedback, we turned off rotation distribution between head and neck joints when data from motion controller is applied to head. (This distribution was introduced in version 4.0.0.223.)

{{VersionShortInfo|4.0.3.226|Sep 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.3.226.exe}}

 N E W    F E A T U R E S:
* Using head and hand orientations set from motion controllers during ''Refine'' that allows to improve tracking in some cases.

 B U G    F I X E S:
* Crash in tracking after deletion of all animation within ROI.
* Occasional tracking failures if tracking is applied to new project without saving it.
* Occasional incorrect hands orientations after tracking or jitter removal if motion controllers data were applied.

 U N D E R    T H E    H O O D:
* Better tracking of complex legs or arms poses in some cases.

{{VersionShortInfo|4.0.2.225|Aug 17, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.2.225.exe}}

 N E W    F E A T U R E S:
* Removing parasite limbs twists that may appear after ''Jitter Removal'' application.

 B U G    F I X E S:
* Removed ''Trajectory Filter'' slider from ''Live'' tab as this setting is not used during live tracking.
* Disable ''Auto adjust camera FOV'' option for calibration projects recorded with action cameras.

 U N D E R    T H E    H O O D:
* Slightly increased accuracy of removing parasite limbs twists when limbs are nearly straight.

{{VersionShortInfo|4.0.1.224|Jul 26, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.1.224.exe}}

 B U G    F I X E S:
* Fixed hand joint rotation tool issues.
* Removed ''Jitter Removal'' dependence from ''Individual Body Parts Tracking'' options.

 U N D E R    T H E    H O O D:
* Improved limbs tracking that removes parasite limbs twists when limbs are nearly straight.
* Increased accuracy of tracking algorithm in some cases due to use of improved joint limits.

{{VersionShortInfo|4.0.0.223|Jul 03, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-4.0.0.223.exe}}

 N E W    F E A T U R E S:
* [[Real-time Tracking for Live Preview]] added.
:{{Note|Supported in '''Basic''' and '''Pro''' editions.}}
* [[User_Guide_for_Multiple_PS_Eye_Cameras_Configuration#Individual_body_parts_tracking|Individual body parts tracking]] for post-processing.
* Improved tracking with the use of motion controllers.
** Joint limits are taken into account when applying motion controllers data to avoid physically impossible joint orientations.
** Rotations are distributed between head and neck joints when tracking head.

 U N D E R    T H E    H O O D:
* Improved background calculation for noisy depth sensors.

{{VersionShortInfo|3.6.6.222|Mar 06, 2018|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.6.222.exe}}

 N E W    F E A T U R E S:
* New '''calibration algorithm''' for depth sensors / light marker method.
** Higher speed.
** Slightly better accuracy.
* New/enhanced automation commands:
** '''get-actor-props'''; '''get-pose-mismatch'''; additional parameters for '''set-actor-props'''.
** '''recenter-coordinates-on-character'''; '''move-coordinate-system'''.
** '''export-video'''; ''videoFilePath'' parameter in '''open-project''' command.
* Added option to take .iPiVideo from project directory if .iPiVideo is not found.
* Allow fractional values for target FPS in Export Options dialog.

 B U G    F I X E S:
* Incorrect Biomech export for multiple actors; first actor exported correctly, other actors used bone lengths of first actor.
* Uneven shoulder height was set for some imported characters.
* Taking into account target character transform when exporting cameras.

 U N D E R    T H E    H O O D:
* Auto adjust camera FOV is checked by default for calibration project (in case when all RGB cameras have the same model).
* FBX import: improved search for a root node.

{{VersionShortInfo|3.6.4.220|Jun 17, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.4.220.exe}}

 N E W    F E A T U R E S:
* '''Export Options''' dialog is now shown for any file format after a destination file is selected. '''Recenter coordinates on character''' and '''Export T-pose in the first frame''' options moved to this dialog (they affect exported animation only). '''Advanced motion transfer''' option is left on the '''Export''' tab (it affects both preview in program and exported animation), but moved up, just below '''Show target character''' option.
* Option for setting the frame rate of an exported animation is added to the '''Export Options''' dialog.
* Export of cameras is available for COLLADA format.

 B U G    F I X E S:
* Incorrect vertical positioning of built-in rigs for Motion Builder and 3ds Max.
* Incorrect positioning of skeleton when exporting with default rig in some situations.
* Values for selected bone were not displayed on the '''Pose''' tab (introduced in 3.6.0).
* App crash on project opening under certain circumstances.
* Motion transfer profile was not saved automatically after changing target character’s orientation.

{{VersionShortInfo|3.6.3.219|May 29, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.3.219.exe}}

 B U G    F I X E S:

* Applying data from motion controllers fails after saving a project.
* A number of bugs with '''Move Coordinate System''' tool:
** App crash
** Frames with default pose were transformed
** Visual glitches

{{VersionShortInfo|3.6.2.218|May 26, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.2.218.exe}}

 B U G    F I X E S:

* Exported animation always has default 30 FPS (introduced in v3.6.0.216).
* Changes in actor appearance are not applied to the target character.

{{VersionShortInfo|3.6.1.217|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.1.217.exe}}

 B U G    F I X E S:

* Crash of license activation during application start

{{VersionShortInfo|3.6.0.216|May 25, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.6.0.216.exe}}

 N E W    F E A T U R E S:
* New calibration algorithm for the light marker method.
** Vastly greater speed
** Slightly better accuracy
{{Tip|In case of problems with the new algorithm, you can revert to using the old algorithm. Check '''Use old calibration algorithm''' in '''Manual Calibration Adjustments > Advanced Calibration Settings''' section on the '''Calibration''' tab.}}
* Including cameras into exported animations in FBX format (optional).
* Vastly increased the speed of applying data from motion controllers.
* Automation add-on:
** Added '''useFastTrackingAlgorithm''' field to the arguments of '''set-tracking-props''' command and to the result of '''get-tracking-props''' command.
** Added '''markerColor''' field to the arguments of '''run-calibration''' command.
** Changed default value of '''autoDetectInitialCameraPositions''' field in '''create-project''' command to <code>true</code>.

 B U G    F I X E S:
* Biomech add-on: Unchecking '''Export RGB''' checkbox when there is no color data.
* Fixed app crash after opening project under certain conditions.
* Fixed displaying of warnings on the '''Calibration''' tab at improper moments.
* Task dialogs after animation/video export were modeless.

{{VersionShortInfo|3.5.1.215|Apr 23, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.1.215.exe}}

 B U G    F I X E S:
* Wrong scale in exported DMX animation (see [https://forum.ipisoft.com/viewtopic.php?f=5&t=9756 forum message]).
* Program crashed on importing character having same-named bones.

{{VersionShortInfo|3.5.0.214|Apr 19, 2017|https://files.ipisoft.com/iPiMocapStudioSetup-3.5.0.214.exe}}

 N E W    F E A T U R E S:
* New fast tracking algorithm for depth sensors (BETA version). To use it, turn on ''Use fast tracking algorithm (BETA)'' checkbox on ''Tracking'' tab.
** Tracking speed increase is up to 2.5 times depending on particular hardware and tracking options.
** Available for single-actor projects, and single-GPU configurations.
{{Tip|If you use 2 GPUs for tracking, you need to turn it off by unchecking second GPU via ''Help > Manage GPU Usage'' menu.}}

* Improvements in animation export.
** New control on ''Export'' tab to rotate imported characters into proper orientation. This is useful for many popular characters, including standard Unreal Engine character.
** The motion is now correctly transferred to imported characters with separate ''Root'' bone and ''Hips/Pelvis'' bone. You can map hips motion either to ''Root'' or to ''Hips/Pelvis''. This is useful for game engine characters, including standard Unity 3D Engine and Unreal Engine characters.
** Support for FBX format 7.5 (2016)
{{Note|Built-in rig for ''Blender'' has been removed, because there is no need in change of axes orientation for modern versions of Blender.}}

* Allow to select flashlight color for marker detection during calibration (useful in case of light background).
* Added finger bones to motion transfer profile for Valve characters in SMD and DMX formats.
* Added hints about GPUs to progress bar area during tracking.
* Showing dialog with common actions available for the exported file after animation export and video export operations.

 B U G    F I X E S:
* Program crashed in case of window resizing during video export.
* Program crashed on certain errors when opening target character and animations. Now errors are reported.
* Automation Add-on could hang in rare cases during events sending.
* Fixed GPU memory leaks on project open / close operations and during calibration.

 U N D E R    T H E    H O O D:
* Improved automatic floor detection both for RGB cameras and depth sensors
* Replaced viewport repaint on every frame during tracking / refine / jitter removal to repaint by timer. May lead to slight speed increase on powerful GPUs.
* Improved tracking / refine / jitter removal speed calcualtion and changed formatting for speed values.
* Using FBX SDK 2017.1 for handling FBX files.
* Fixed speed degradation issue during calibration using board for depth projects.
* For multiple GPU configuration the old tracking algorithm is set to be used in case number of cameras is over 6. In most cases this is faster than using default tracking on single GPU.

{{VersionShortInfo|3.4.16.212|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.16.212.exe}}

 B U G    F I X E S:
* Import of target character crashed.

{{VersionShortInfo|3.4.15.211|Nov 29, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.15.211.exe}}

 B U G    F I X E S:
* Tracking worked incorrectly on Intel integrated graphics and some other weak video cards.
* Jitter removal / tracking hanged in rare cases.
* Incorrect pose visualized during tracking in the first frame of ''Region-of-Interest''.
* Tracking crashed with exception ''Wait for frame ... failed'' in rare cases.

 U N D E R    T H E    H O O D:
* Fixed GPU memory leaks.

{{VersionShortInfo|3.4.12.208|Oct 13, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.4.12.208.exe}}

 N E W    F E A T U R E S:
* Increased speed of tracking operations.
** Maximum speed increase (up to 3-4 times) is achieved at high-performance video cards for projects recorded with 1 or 2 Kinect sensors.
** For 4 or more Sony PS3 Eye cameras speed gain is lower and can reach 10 – 50% depending on particular tracking options and hardware configuration.
** For slow video cards speed increase is substantially lower.
** For projects recorded with many cameras tracking speed can even be lower compared to previous version on particular hardware configurations. You have the option to use the old tracking algorithm then (you can select this option in Advanced Tracking Settings section of the Tracking tab)
** For multiple GPU configuration the new algorithm will be used if number of cameras / sensors is not more than 4 (in this case only the primary GPU is used). In most cases this will still be faster than using multiple GPUs with the old tracking algorithm. For more than 4 cameras the old algorithm on multiple GPUs will be used, as a faster option.

{{VersionShortInfo|3.3.10.206|Sep 23, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.10.206.exe}}

 B U G    F I X E S:
* Jitter removal crashed on projects recorded with Kinect v1 containing RGB video information.

 U N D E R    T H E    H O O D:
* Further improvement of responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.9.205|Sep 15, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.9.205.exe}}

 N E W    F E A T U R E S:
* Further increase of jitter removal speed. Improved algorithm is 10-20% faster compared to the previous release. Speed increase depends on particular hardware (GPU and CPU).

 B U G    F I X E S:
* Biomech Add-on free trial activation did not work.
* Periodic Auto-Save did not work in jitter removal. Now the project is saved every 30 seconds.
* Memory leaks in jitter removal.
* Crashed if timeline slider is clicked during jitter removal or tracking operation.

 U N D E R    T H E    H O O D:
* Improved responsiveness of user interface during jitter removal on computers with slow video cards.

{{VersionShortInfo|3.3.8.204|Sep 01, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.8.204.exe}}

 N E W    F E A T U R E S:
* Increased speed of jitter removal. New algorithm is 3-7 times faster compared to the previous one. Speed increase depends on particular hardware (GPU and CPU).
* Trajectory filter is improved for noisy data.

 B U G    F I X E S:
* Tracking operations of multiple depth sensors projects failed with exception on some models of ''Nvidia'' cards using drivers 372.54, 372.70.

{{VersionShortInfo|3.3.7.203|Jul 14, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.3.7.203.exe}}

 N E W    F E A T U R E S:
* '''iPi Automation Add-on''' released.<br>This tool allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending JSON commands via Windows dll. It can be used for:
** Using [[iPi Recorder]] and [[iPi Mocap Studio]] as a part of a third-party solution;
** Automation of repeatable tasks;
** Automation of custom workflow.
{{Note|Add-on is not a free update and requires separate license key. 30-days free trial is [[iPi_Automation_Add-on#License_and_Trial|available]]. For more information please read [[iPi Automation Add-on]] documentation.}}

{{VersionShortInfo|3.2.7.201|May 03, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.7.201.exe}}

 B U G    F I X E S:
* Jitter Removal failed on some models of video cards.

{{VersionShortInfo|3.2.6.200|Apr 25, 2016|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.6.200.exe}}

 N E W    F E A T U R E S:.
* Increased tracking quality for actors with adjusted proportions.
* Allow opening of a processed [[.iPiMotion File Extension|'''.iPiMotion''']] file without video, for 3D data viewing.
* ''Hide Background'' option button / menu item for RGB video.
* Improved UI for light settings:
** Store light settings to scene file;
** Automatic loading of light settings from previous project when creating new project;
** ''Place Light to the Current Virtual Camera Position'' button added to Scene tab.
* No Auto-Play after project open.
* Calibration: UI enhancements for manual marking of ground points.
* Calibration: edit box for typing in camera height added.
* Control for manual alignment of coordinate system on the ''Scene'' tab.
* Biomech export: added lengths of body segments, eye positions.
* Support of Intel [http://www.intel.com/content/www/us/en/architecture-and-technology/realsense-longrange.html RealSense R200] sensor.
** Please be aware that R200 depth quality is lower compared to Kinect sensors so far, so tracking accuracy may deteriorate.

 U N D E R    T H E    H O O D:
* Calibration: additional ground detection quality check.

{{VersionShortInfo|3.2.5.193|Nov 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.5.193.exe}}

 N E W    F E A T U R E S:
* [[Using_Tracking_Data_from_Depth_Sensors|Improved workflow]] with the use of '''Kinect 2''' tracking data.

 B U G    F I X E S:
* Update target character pose after '''Refit Pose'''.

 U N D E R    T H E    H O O D:
* Do not auto play on project opening or after importing a target character.

{{VersionShortInfo|3.2.4.191|Aug 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.4.191.exe}}

 N E W    F E A T U R E S:
* Improvements in pose editing tools:
** Highlighting selectable objects (e.g. bones) on mouse hover;
** Rendering tool controls in front of all objects for ease of use;
** Displaying highlighted bone’s name in the bottom-right (previously, only selected bone’s name was displayed).
* Improvements in editing of motion profiles:
** Ability to select target bones directly from target character’s skeleton in the scene;
** Highlighting target character’s bones when scrolling through combo boxes in '''Target Bone''' column;
** Automatic assignment of symmetric bones (left/right).
* Minor improvements in rendering of the scene.

 B U G    F I X E S:
* Compatibility of secondary GPUs is determined incorrectly.
* Application crashes when the Pose Mismatch view is activated on multiple GPUs.
* Initial length of ROI and Take 1 is defined improperly in projects created from records with non-standard frame rate (recorded after warning about low frame rate).
* Pose of target character is not updated when actor’s pose is manually edited while staying on the same frame.

{{VersionShortInfo|3.2.3.190|Aug 08, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.3.190.exe}}

 N E W    F E A T U R E S:
* Visual bone picker. Located in drop-down of the Select button in the top toolbar and on the Pose tab.

[[File:release-notes-3.2.3.190-visual-bone-picker.png|200px]]

 B U G    F I X E S:
* Performance degradation when using multiple GPUs in certain configurations.
* Sound controls are missing in the bottom toolbar for projects with audio data.
* Calibration freezes under rare conditions.
* Application crash during calibration when applying to an action video by mistake in certain situations.

 U N D E R    T H E    H O O D:
* Improved background subtraction for records made with Kinect 2 sensors to keep more details.

{{VersionShortInfo|3.2.2.189|Jun 17, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.2.189.exe}}

 N E W    F E A T U R E S:
* Improved color picture quality for PlayStation Eye cameras and Kinect v1 depth sensors.
* Dropped support for DirectX 10 video cards.
*: Previously many core operations like tracking were already unavailable for such cards. Now program will not run at all.

 B U G    F I X E S:
* Incorrect marker detection during calibration on some records. Only AMD and Intel GPUs were affected.
* Incorrect character rendering on Intel HD4xxx series and above.
*: This issue may still occur on prolonged running of application. In this case restarting the application helps.

 U N D E R    T H E    H O O D:
* Some optimizations in usage of graphic resources.
* Correct installation of older version over newer one.
*: Previously uninstallation was required.

{{VersionShortInfo|3.2.1.187|May 02, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.1.187.exe}}

 N E W    F E A T U R E S:
* Substantial speed-up of marker detection during the calibration. (Up to 3 times depending on hardware and settings).

 B U G    F I X E S:
* UI freezing when in the '''Pose Mismatch''' mode under certain conditions.
* Incorrect rendering of video frame on some video cards.
* Import of a target character with the same skeleton structure as the model in Mocap Studio results in error.
* Incorrect values displayed for occlusions percent in the calibration statistics.

{{VersionShortInfo|3.2.0.182|Apr 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.2.0.182.exe}}

 N E W    F E A T U R E S:
* Added settings for adjusting proportions of the actor's model:
** legs length;
** arms length;
** shoulders width;
** head size;
** feet size.
* Layout of the '''Actor''' tab has been changed slightly.
* Settings for adjusting the size of a light marker in calibration projects.
* Improved automatic evaluation of calibration quality for multiple depth sensors.

 U N D E R    T H E    H O O D:
* Improved processing of program crashes.

{{VersionShortInfo|3.1.2.177|Mar 19, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.2.177.exe}}

 N E W    F E A T U R E S:
* '''Biomech Add-on''': added [[iPi_Biomech_Add-on#Export_Point_Cloud|point cloud export]] formats convenient for animators, including [https://www.thinkboxsoftware.com/krak-prt-11-file-format/ Krakatoa PRT], [https://en.wikipedia.org/wiki/PLY_(file_format) PLY], [https://en.wikipedia.org/wiki/Wavefront_.obj_file OBJ], Leika PTS.

{{VersionShortInfo|3.1.1.175|Feb 24, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.1.175.exe}}

 N E W    F E A T U R E S:
* New menu items '''View > Cameras''' and '''View > Source of Light''' allow to remove camera and source of light objects from 3D scene if needed.

 B U G    F I X E S:
* FBX import and export do not support national (non-ASCII) characters in file path.
* Projects with three actors are always created in [[.iPiLocked File Extension|.iPiLocked format]] even in [https://www.ipisoft.com/software/pro-edition Pro edition].

{{VersionShortInfo|3.1.0.173|Feb 20, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.1.0.173.exe}}

 N E W    F E A T U R E S:
* [https://www.ipisoft.com/software/basic-edition Basic] and [https://www.ipisoft.com/software/trial-edition Free Trial] editions now support up to '''six (6)''' color cameras like Sony PS3 Eye. In previous versions this limit was four (4).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''sixteen (16)''' color cameras like Sony PS3 Eye. In previous versions this limit was eight (8).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''four (4)''' depth sensors. In previous versions this limit was three (3).
* [https://www.ipisoft.com/software/pro-edition Pro] edition now supports up to '''three (3)''' actors tracking. In previous versions this limit was two (2).
*: {{Note|For three actors tracking it is highly recommended to use at least nine (9) color cameras like Sony PS3 Eye.}}
* '''Extended''' and '''Extreme''' calibration modes for complex cases.
* Bunch of minor improvements.

 B U G    F I X E S:
* In rare cases calibration results in upside down configuration.
* In rare cases '''Pause''' button is not clickable.

{{VersionShortInfo|3.0.3.172|Jan 07, 2015|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.3.172.exe}}

 N E W    F E A T U R E S:
* Improved progress indication for some operations - for example, video export and data export in Biomech addon. Removed progress indication in the scene (the spinning "wheel").
* Scaling the actor's model relative to the floor when adjusting its height.

 B U G    F I X E S:
* App crash during the calibration of dual Kinect 2 configuration using a board.
* App crash during the export of point cloud from Kinect 2.
* App crash when trying to remove an entry from the list of MRU hand poses.

{{VersionShortInfo|3.0.2.171|Nov 26, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.2.171.exe}}

 N E W    F E A T U R E S:
* Additional improvements in calibration procedure:
** flashlight marker detection becomes faster and more robust;
** calibration of multiple Kinect 2 sensors with the aid of flashlight is now supported;
** undo/redo is now fully functional for calibration projects;
** automatic detection of ground points is slightly improved to become more reliable in complex cases.
* Options for FBX export:
** FBX version;
** Binary/ASCII format.
* Manual ground height fine-tuning for action projects ('''Scene''' tab).
* Message about incompatible video card on execution of Tracking / Refine / Refit Pose if video card is not '''DirectX 11''' capable.
* Reduced memory footprint.

 B R E A K I N G    C H A N G E S:
* Binary format of project files is slightly changed. This version can open projects saved by previous versions. But previous versions are unable to open projects saved by this version.

 B U G    F I X E S:
* Tracking overrides key frames for hands.
* Wrong position of video billboard for projects from depth sensors when alignment of color video to depth is switched off.
* FBX import/export doesn't work in rear cases: OS is Windows 7 64-bit, Service Pack 1 is not installed, CPU supports AVX instructions set (e.g. Intel Core i3/i5/i7 Haswell).
* Fatal error "NullReferenceException" during application start up in rear cases.
* Minor bugs in visibility of imported character's bones and opacity of imported character's skin.

{{VersionShortInfo|3.0.1.169|Nov 11, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.1.169.exe}}

 N E W    F E A T U R E S:
* Disabling tabs area and some keyboard shortcuts during processing to prevent unintentional interruption of operation.

 B U G    F I X E S:
* Crash on start on hardware configurations with high resolution display and 2 GB (or less) video card.
* Processing speed degradation on Windows 7.
* Rare false failure of integrity check in certain environments.

{{VersionShortInfo|3.0.0.166|Nov 03, 2014|https://files.ipisoft.com/iPiMocapStudioSetup-3.0.0.166.exe}}

The first public release of [[iPi Mocap Studio|iPi Mocap Studio 3]]. If you're user of '''iPi Studio 2.x''' or '''iPi Studio 1.x''' then please visit [[Migration to V3 from Older Versions]] article.

 N E W    F E A T U R E S:
* Support of new depth sensors: [[Depth Sensors Comparison|Kinect for Xbox One / Kinect 2 for Windows]].
* Improved calibration:
** more reliable;
** faster;
** automatic ground detection;
** calibration quality feedback.
* Improved tracking for arms and legs.
* Redesigned user interface.
* Comprehensive progress indicators.
* Improved user interface for animation export and motion transfer.
* More accurate center of mass calculation.
* Tons of minor improvements and fixes.

 B R E A K I N G    C H A N G E S:
* New project file formats: [[.iPiVideo File Extension|.iPiVideo]], [[.iPiCalib File Extension|.iPiCalib]] and [[.iPiLocked File Extension|.iPiLocked]]. V2 projects can be opened and stored to the new format.

 U N D E R    T H E    H O O D:
* Migration to DirectX 11.
* Moving to Microsoft .Net 4.5.1 Platform.
* Using new installation and auto-update system instead of buggy ClickOnce technology.

AI-based Tracking

2023-09-06T06:10:52Z

Pavel:

AI-based Tracking

2023-09-06T06:09:50Z

Pavel:

== Introduction ==

Starting from version '''4.6.0''' the [[iPi Mocap Studio]] offers new features that are based on integration with 3<sup>rd</sup> party AI (artificial intelligence) libraries like [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR SDK].

These features are marked as '''"AI-based"''' or simply '''"(AI)"''' on UI and aimed to help with auxiliary tasks like:
* detect initial actor pose
* automatically fix tracking errors
* track feet, hands and head rotations

== System Requirements ==

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>OS</th><td>MS Windows 10 or 11 64-bit</td></tr>
<tr><th>RAM</th><td>8GB or higher</td></tr>
<tr><th>GPU</th><td>NVIDIA RTX 20/30/40 Series, or NVIDIA Quadro RTX or NVIDIA RTX professional GPUs</td></tr>
<tr><th>DRIVER</th><td>NVIDIA Display Driver version 520.46 or higher</td></tr>
</table>

''If your system is not compatible, you can hide all new UI elements that requires AI libraries via '''Hide all AI-based Features on UI''' checkbox in '''Backward Compatibility''' collapsible group box on '''Tracking''' tab:''
<center>[[File:hide-all-ai-based-features.png]]</center>

== 3rd Party Libraries Installation ==

To be able to use AI-based features, you should download and install [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime on your own. It can be done either by downloading appropriate version of AR 0.8.2 runtime from the following page [https://www.nvidia.com/broadcast-sdk-resources], or via the following dialog automatically shown by [[iPi Mocap Studio]] when AI-based detectors are required but [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime cannot be found in the system:

<center>[[File:maxine-ar-0 8 2-required-dlg.png]]</center>

== Limitations of Current Version ==

Currently, AI-based features are only available for the following types of projects/videos:
* Multi camera RGB video, single actor
* Single or multi depth sensor video with color data, single actor

''That is, if your project contains multiple actors or it is recorded with the aid of depth sensor(s) without color data (only depth maps, no RGB images) then you are unable to use new AI-based features. Support for multiple actors will be added in future versions.''

== How to Use ==

=== Detect Pose (AI) ===

This feature is available on two Tabs: '''Actor''' and '''Tracking'''.

<center><table border="0">
<tr><td>[[File:actor-detect-pose-ai.png]]</td><td>  </td><td>[[File:tracking-detect-pose-ai.png]]</td></tr>
</table></center>

In both cases, AI pose detector is applied to all available RGB images in the current frame, after that detection results are combined from all cameras, post-processed and Inverse Kinematics (IK) is used to produce pose of 3D character. This functionality is very useful to set initial pose before tracking or to fix tracking errors.

{{Tip|You can visualize raw output of AI detector for each camera by selecting '''View > Raw AI Skeleton''' item in the main menu. ''Raw AI Skeleton'' is shown as green balls connected with yellow sticks. Switch between cameras to see results for each camera.}}

<center>[[File:view-raw-ai-skeleton.png]]</center>

After that, you can apply Refit Pose in most cases to refine 3D character position based on iPi proprietary tracking algorithms. However, please remember that correct actor parameters must be specified before using of Refit Pose.

=== Detect Pose and Height (AI) ===

'''Detect Pose and Height (AI)''' is available on '''Actor''' tab as an item in drop-down menu under '''Auto Adjust Actor Pose''' button. This feature works similar to the previous one but in addition to pose detection, it estimates actor’s height. The accuracy of such detection depends on pose, cameras views, etc. In most cases, it is better to set height manually if you know it. However, you can give it a try and see if it works for you.

<center>[[File:actor-detect-pose-and-height-ai.png]]</center>

=== AI-based feet tracking ===

Now there are three options for feet tracking:
# '''Do not track'''. Feet are not tracked and have default position (zero rotation) in all frames. Corresponds to unchecked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track'''. Proprietary iPi algorithms are used to track feet. Corresponds to checked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track (AI-based)'''. AI detectors are used to determine feet positions in each frame during tracking pass. First introduced in version '''4.6.0.'''

''In some cases, iPi proprietary algorithms work better for feet, but for other videos AI-based tracking can be really useful.''

<center><table border="0">
<tr><td>[[File:tracking-settings-feet_4_6_0.png]]</td><td>  </td><td>[[File:tracking-settings-feet_4_5_8.png]]</td></tr>
<tr><th>v.4.6.0</th><th></th><th>v.4.5.8</th></tr>
</table></center>

{{Tip|AI-based tracking is very noisy. For this reason, please do not forget to apply aggressive [[Automatic_Refinement_and_Filtering|Jitter Removal]] for body parts tracked with the help of AI.}}

=== AI-based head tracking ===

Similar to feet tracking, head position can be tracked with the aid of iPi proprietary algorithms or based on AI detectors. Again, for some videos (especially depth ones) AI-based approach can be more accurate.

=== AI-based hands tracking ===

In addition to feet and head, AI-based tracking can be applied to hands. Currently, only rotations for hands is supported. Neither thumb nor fingers positions are tracked. Use [[Hand_Keyframing|key framing]] for fingers, as before. In addition, accuracy of hands rotations determined by AI-based algorithms depends on hands visibility in cameras.

<center>[[File:tracking-settings-hands-ai.png]]</center>

=== Applying only AI-based tracking ===

When one chooses AI-based tracking for Head/Hands/Feet, it applies during standard Tracking Forward / Backward pass along with iPi incremental tracking for full body. But when tracking has already been performed and there is no need to re-track frames in ROI, one can apply only AI-based tracking for Head/Hands/Feet (depending on selected settings for them). To do it, click on down arrow in the right part of '''Track Forward/Backward''' buttons and choose '''AI-based Only''' item in drop-down menu. This could be helpful during experiments with different AI options because it allows applying changes fast.

<center>[[File:tracking-ai-based-only.png]]</center>

{{Note|If AI-based tracking is not selected for any body part, or tracking is turned off for all individual body parts that requires AI-based tracking, then '''AI-based Only''' option is not available in the drop-down menu.}}

=== Automatic tracking errors fixing ===

AI-based pose detection can help fixing tracking errors:
* Choose frame with erroneous pose after tracking
* Click '''Detect Pose (AI)''' button to set pose roughly based on AI detectors
* Then click '''Refit Pose''' button to refine detected pose

In most cases, it should fix pose in the selected frame. But what to do when there are many sequential frames with erroneous poses? First, it is worth to try re-tracking in different direction from the fixed pose. It could help. If not then new '''Auto Fix Pose (AI-based)''' tracking option should be applied.

<center>[[File:tracking-auto-fix-pose-ai.png]]</center>

This option applies '''Detect Pose (AI)''' followed by '''Refit Pose''' actions for each frame in Forward/Backward directions, starting from the current frame.

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}

AI-based Tracking

2023-09-06T06:09:28Z

Pavel:

== Introduction ==

Starting from version '''4.6.0''' the [[iPi Mocap Studio]] offers new features that are based on integration with 3<sup>rd</sup> party AI (artificial intelligence) libraries like [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR SDK].

These features are marked as '''"AI-based"''' or simply '''"(AI)"''' on UI and aimed to help with auxiliary tasks like:
* detect initial actor pose
* automatically fix tracking errors
* track feet, hands and head rotations

== System Requirements ==

<table class="wikitable" style="font-size:smaller;min-width:50%">
<tr><th>OS</th><td>MS Windows 10 or 11 64-bit</td></tr>
<tr><th>RAM</th><td>8GB or higher</td></tr>
<tr><th>GPU</th><td>NVIDIA RTX 20/30/40 Series, or NVIDIA Quadro RTX or NVIDIA RTX professional GPUs</td></tr>
<tr><th>DRIVER</th><td>NVIDIA Display Driver version 520.46 or higher</td></tr>
</table>

''If your system is not compatible, you can hide all new UI elements that requires AI libraries via '''Hide all AI-based Features on UI''' checkbox in '''Backward Compatibility''' collapsible group box on '''Tracking''' tab:''
<center>[[File:hide-all-ai-based-features.png]]</center>

== 3rd Party Libraries Installation ==

To be able to use AI-based features, you should download and install [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime on your own. It can be done either by downloading appropriate version of AR 0.8.2 runtime from the following page [https://www.nvidia.com/broadcast-sdk-resources], or via the following dialog automatically shown by [[iPi Mocap Studio]] when AI-based detectors are required but [https://github.com/NVIDIA/MAXINE-AR-SDK#readme NVIDIA Maxine AR 0.8.2] runtime cannot be found in the system:

<center>[[File:maxine-ar-0 8 2-required-dlg.png]]</center>

== Limitations of Current Version ==

Currently, AI-based features are only available for the following types of projects/videos:
* Multi camera RGB video, single actor
* Single or multi depth sensor video with color data, single actor

''That is, if your project contains multiple actors or it is recorded with the aid of depth sensor(s) without color data (only depth maps, no RGB images) then you are unable to use new AI-based features. Support for multiple actors will be added in future versions.''

== How to Use ==

=== Detect Pose (AI) ===

This feature is available on two Tabs: '''Actor''' and '''Tracking'''.

<center><table border="0">
<tr><td>[[File:actor-detect-pose-ai.png]]</td><td>  </td><td>[[File:tracking-detect-pose-ai.png]]</td></tr>
</table></center>

In both cases, AI pose detector is applied to all available RGB images in the current frame, after that detection results are combined from all cameras, post-processed and Inverse Kinematics (IK) is used to produce pose of 3D character. This functionality is very useful to set initial pose before tracking or to fix tracking errors.

{{Tip|You can visualize raw output of AI detector for each camera by selecting '''View > Raw AI Skeleton''' item in the main menu. ''Raw AI Skeleton'' is shown as green balls connected with yellow sticks. Switch between cameras to see results for each camera.}}

<center>[[File:view-raw-ai-skeleton.png]]</center>

After that, you can apply Refit Pose in most cases to refine 3D character position based on iPi proprietary tracking algorithms. However, please remember that correct actor parameters must be specified before using of Refit Pose.

=== Detect Pose and Height (AI) ===

'''Detect Pose and Height (AI)''' is available on '''Actor''' tab as an item in drop-down menu under '''Auto Adjust Actor Pose''' button. This feature works similar to the previous one but in addition to pose detection, it estimates actor’s height. The accuracy of such detection depends on pose, cameras views, etc. In most cases, it is better to set height manually if you know it. However, you can give it a try and see if it works for you.

<center>[[File:actor-detect-pose-and-height-ai.png]]</center>

=== AI-based feet tracking ===

Now there are three options for feet tracking:
# '''Do not track'''. Feet are not tracked and have default position (zero rotation) in all frames. Corresponds to unchecked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track'''. Proprietary iPi algorithms are used to track feet. Corresponds to checked state of '''Enable foot tracking''' checkbox in previous versions of [[iPi Mocap Studio]].
# '''Track (AI-based)'''. AI detectors are used to determine feet positions in each frame during tracking pass. First introduced in version '''4.6.0.'''

''In some cases, iPi proprietary algorithms work better for feet, but for other videos AI-based tracking can be really useful.''

<center><table border="0">
<tr><td>[[File:tracking-settings-feet_4_6_0.png]]</td><td>  </td><td>[[File:tracking-settings-feet_4_5_8.png]]</td></tr>
<tr><th>v.4.6.0</th><th></th><th>v.4.5.8</th></tr>
</table></center>

{{Tip|AI-based tracking is very noisy. For this reason, please do not forget to apply aggressive [[Automatic_Refinement_and_Filtering|Jitter Removal]] for body parts tracked with the help of AI.}}

=== AI-based head tracking ===

Similar to feet tracking, head position can be tracked with the aid of iPi proprietary algorithms or based on AI detectors. Again, for some videos (especially depth ones) AI-based approach can be more accurate.

=== AI-based hands tracking ===

In addition to feet and head, AI-based tracking can be applied to hands. Currently, only rotations for hands is supported. Neither thumb nor fingers positions are tracked. Use [[Hand_Keyframing|key framing]] for fingers, as before. In addition, accuracy of hands rotations determined by AI-based algorithms depends on hands visibility in cameras.

<center>[[File:tracking-settings-hands-ai.png]]</center>

=== Applying only AI-based tracking ===

When one chooses AI-based tracking for Head/Hands/Feet, it applies during standard Tracking Forward / Backward pass along with iPi incremental tracking for full body. But when tracking has already been performed and there is no need to re-track frames in ROI, one can apply only AI-based tracking for Head/Hands/Feet (depending on selected settings for them). To do it, click on down arrow in the right part of '''Track Forward/Backward''' buttons and choose '''AI-based Only''' item in drop-down menu. This could be helpful during experiments with different AI options because it allows applying changes fast.

<center>[[File:tracking-ai-based-only.png]]</center>

{{Note|If AI-based tracking is not selected for any body part, or tracking is turned off for all individual body parts that requires AI-based tracking, then '''AI-based Only''' option is not available in the drop-down menu.}}

=== Automatic tracking errors fixing ===

AI-based pose detection can help in fixing of tracking errors:
* Choose frame with erroneous pose after tracking
* Click '''Detect Pose (AI)''' button to set pose roughly based on AI detectors
* Then click '''Refit Pose''' button to refine detected pose

In most cases, it should fix pose in the selected frame. But what to do when there are many sequential frames with erroneous poses? First, it is worth to try re-tracking in different direction from the fixed pose. It could help. If not then new '''Auto Fix Pose (AI-based)''' tracking option should be applied.

<center>[[File:tracking-auto-fix-pose-ai.png]]</center>

This option applies '''Detect Pose (AI)''' followed by '''Refit Pose''' actions for each frame in Forward/Backward directions, starting from the current frame.

{{Note|This approach is applicable even when AI-based tracking is not selected for any body part.}}