LICENSES/BSD-2-Clause.txt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Copyright (c) <year> <owner>. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# SPDX-License-Identifier: CC0-1.0

# Capture script example
#
# A capture script allows to associate a list of controls and their values
# to frame numbers.
#
# The script allows defining a list of frames associated with controls
# and an optional list of properties that can control the script behaviour.

# properties:
#   # Repeat the controls every 'idx' frames.
#   - loop: idx
#
# # List of frame number with associated a list of controls to be applied
# frames:
#   - frame-number:
#       Control1: value1
#       Control2: value2

# \todo Formally define the capture script structure with a schema

# Notes:
# - Controls have to be specified by name, as defined in the
#   libcamera::controls:: enumeration
# - Controls not supported by the camera currently operated are ignored
# - Frame numbers shall be monotonically incrementing, gaps are allowed
# - If a loop limit is specified, frame numbers in the 'frames' list shall be
#   less than the loop control

# Example: Turn brightness up and down every 460 frames

properties:
  - loop: 460

frames:
  - 0:
      Brightness: 0.0

  - 40:
      Brightness: 0.2

  - 80:
      Brightness: 0.4

  - 120:
      Brightness: 0.8

  - 160:
      Brightness: 0.4

  - 200:
      Brightness: 0.2

  - 240:
      Brightness: 0.0

  - 280:
      Brightness: -0.2

  - 300:
      Brightness: -0.4

  - 340:
      Brightness: -0.8

  - 380:
      Brightness: -0.4

  - 420:
      Brightness: -0.2