Barcode.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * 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.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS 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.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <Zivid/BoundingBox.h>
#include <Zivid/Camera.h>
#include <Zivid/Detail/CoreExport.h>
#include <Zivid/Detail/Pimpl.h>
#include <Zivid/Experimental/Toolbox/BarcodeFormats.h>
#include <Zivid/Frame2D.h>
#include <Zivid/Point.h>
 
#include <optional>
#include <ostream>
#include <string>
#include <vector>
 
namespace Zivid
{
    namespace Experimental
    {
        namespace Toolbox
        {
            class LinearBarcodeDetectionResult
            {
                ZIVID_PIMPL_VALUE_SEMANTICS(LinearBarcodeDetectionResult, ZIVID_CORE_EXPORT);
 
            public:
                ZIVID_CORE_EXPORT PointXY centerPosition() const;

                ZIVID_CORE_EXPORT BoundingBox boundingBox() const;

                ZIVID_CORE_EXPORT std::string toString() const;
            };

            ZIVID_CORE_EXPORT std::ostream &operator<<(
                std::ostream &stream,
                const LinearBarcodeDetectionResult &result);

            class LinearBarcodeDecodingResult
            {
                ZIVID_PIMPL_VALUE_SEMANTICS(LinearBarcodeDecodingResult, ZIVID_CORE_EXPORT);
 
            public:
                ZIVID_CORE_EXPORT std::string code() const;

                ZIVID_CORE_EXPORT LinearBarcodeFormat codeFormat() const;

                ZIVID_CORE_EXPORT PointXY centerPosition() const;

                ZIVID_CORE_EXPORT BoundingBox boundingBox() const;

                ZIVID_CORE_EXPORT std::string toString() const;
            };

            ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const LinearBarcodeDecodingResult &result);

            class MatrixBarcodeDecodingResult
            {
                ZIVID_PIMPL_VALUE_SEMANTICS(MatrixBarcodeDecodingResult, ZIVID_CORE_EXPORT);
 
            public:
                ZIVID_CORE_EXPORT std::string code() const;

                ZIVID_CORE_EXPORT MatrixBarcodeFormat codeFormat() const;

                ZIVID_CORE_EXPORT PointXY centerPosition() const;

                ZIVID_CORE_EXPORT BoundingBox boundingBox() const;

                ZIVID_CORE_EXPORT std::string toString() const;
            };

            ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const MatrixBarcodeDecodingResult &result);

            class BarcodeDetector
            {
                ZIVID_PIMPL_REFERENCE_SEMANTICS(BarcodeDetector, ZIVID_CORE_EXPORT);
 
            public:
                ZIVID_CORE_EXPORT BarcodeDetector();

                ZIVID_CORE_EXPORT Settings2D suggestSettings(Camera &camera) const;

                ZIVID_CORE_EXPORT std::vector<LinearBarcodeDetectionResult> detectLinearCodes(
                    const Frame2D &frame2d) const;

                ZIVID_CORE_EXPORT std::vector<std::optional<LinearBarcodeDecodingResult>> decodeLinearCodes(
                    const std::vector<LinearBarcodeDetectionResult> &detectionResults,
                    const LinearBarcodeFormatFilter &formatFilter = LinearBarcodeFormatFilter::all()) const;

                ZIVID_CORE_EXPORT std::vector<LinearBarcodeDecodingResult> readLinearCodes(
                    const Frame2D &frame2d,
                    const LinearBarcodeFormatFilter &formatFilter = LinearBarcodeFormatFilter::all()) const;

                ZIVID_CORE_EXPORT std::vector<MatrixBarcodeDecodingResult> readMatrixCodes(
                    const Frame2D &frame2d,
                    const MatrixBarcodeFormatFilter &formatFilter = MatrixBarcodeFormatFilter::all()) const;

                ZIVID_CORE_EXPORT std::string toString() const;
            };

            ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const BarcodeDetector &barcodeDetector);

            ZIVID_CORE_EXPORT std::string toString(LinearBarcodeFormat format);

            ZIVID_CORE_EXPORT std::string toString(MatrixBarcodeFormat format);
        } // namespace Toolbox
    } // namespace Experimental
} // namespace Zivid