Web Demos

BARCODE READER SDK DEMO

Explore the flexibe barcode reading settings to optimize for your specific usage scenario.

WEB TWAIN SDK DEMO

Try the most popular web scanner features: scan images, import local images and PDF files, edit, save to local, upload to database, and etc.

BARCODE READER JAVASCRIPT DEMO

Transform any camera-equipped devices into real-time, browser-based barcode and QR code scanners.

MRZ SCANNER WEB DEMO

Detects the machine-readable zone of a passport, scans the text, and parses into human-readable data.

APP STORE DEMOS

BARCODE READER SDK FOR IOS

BARCODE READER SDK FOR ANDROID

VIEW MORE DEMOS >
Dev Center
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

Use Format Specific Configuration

FormatSpecification is part of the configuration template and allows you to configure settings that apply only to the specified barcode format. Note that in order to use this feature, you must use a template instead of RuntimeSettings. Read more on RuntimeSettings and templates.

This article covers the following parameters provided in a FormatSpecification object:

BarcodeFormatIds, BarcodeFormatIds_2

Specifies the barcode type for which the FormatSpecification object applies. This is essential to make any format specific configuration. Read on to see how it is used in actual templates.

MirrorMode

This parameter specifies whether to decode mirror barcodes.

Sometimes the image we get is a mirror image of the actual scene. For example, the following is a normal QR code

normal QR

and this is the same code when mirrored:

mirror QR

For 2D barcodes, mirroring may cause the decoding to fail. In this case, we can configure MirrorMode to handle it. The allowed values are

Enumeration Value Note
MM_NORMAL 0x01 Decode the original image.
MM_MIRROR 0x02 Decode the mirror image.
MM_BOTH 0x04 Try both the original and the mirror images.

The default value of MirrorMode is

  • MM_BOTH for QRCode, DataMatrix, PDF417, AZTEC, Micro QR Code, Micro PDF417, DotCode, Pharmacode Two-Track
  • MM_NORMAL for other barcode types.

In most cases, the default value will work fine. But assuming that you work excusively with mirrored QR codes, you can configure DBR like this:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Read mirror barcodes.", 
        "FormatSpecificationNameArray": ["FP_1"]
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds": ["BF_QR_CODE"], 
            "MirrorMode":"MM_MIRROR"
        }
    ], 
    "Version": "3.0"
}   

RequireStartStopChars

This parameter specifies whether decoding requires start and stop symbols.

1D barcodes usually have fixed start and stop symbols. Normally, DBR can only decode a barcode properly if it finds the start and stop symbols. However, in some cases, the actual barcode symbol may be missing the start and/or stop symbols. RequireStartStopChars is designed to read these non-standard barcodes and is used to specify whether the start and stop symbols are required for decoding. The allowed values are

  • 0: start and stop symbols are optional
  • 1: start and stop symbols are required

The figure below shows a standard Code39 with start and stop symbols:

standard-code39

This one shows the same barcode without start and stop symbols:

code39 without start and end pattern

The following template configures DBR to read Code39 barcodes that don’t have start and/or stop symbols:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Read barcodes without start or end symbols.", 
        "FormatSpecificationNameArray": ["FP_1"]
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds": ["BF_CODE_39"],                      
            "RequireStartStopChars":0
        }
    ], 
    "Version": "3.0"
}   

AllModuleDeviation

This parameter specifies the deviation of the bar width from the standard bar width for 1D barcodes. The default value is 0.

Occasionally, due to typographical errors, 1D barcodes may contain bars of non-standard widths. Such barcodes are considered invalid and ignored by DBR. If you want DBR to read these barcodes, you can use the parameter AllModuleDeviation.

Note that “all” in the parameter name means it only works if all bars (black & white) of the barcode are off (have the same deviation). For example, if the width (in pixels) of bars for a standard barcode are [6, 2, 4, 2], a deviation of 2 would mean the widths become [8, 4, 6, 4], whereas the widths [12, 4, 8, 4] would be considered correctly enlarged.

To utilize this parameter, you need to set the following parameters as well:

  1. FormatSpecification.BarcodeFormatIds_2 should be set to NON_STANDARD_BARCODE, which indicates that the barcode to be read does not strictly follow any standard format.

  2. FormatSpecification.StandardFormat should be set to a standard 1D barcode format such as BF_CODE128 on which DBR applies the deviation.

  3. ImageParameter.BarcodeFormatIds_2 should be set to NON_STANDARD_BARCODE, which means non-standard barcodes are to be read.

The following shows a standard Code128 barcode with a module size of 2px followed by a non-standard Code128 barcode which consists of bars with a deviation of 2px.

standard-code128

code128-deviation

To read this non-standard barcode, we can set the deviation to 2 as shown in the following template:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Read barcodes with width deviation.", 
        "FormatSpecificationNameArray": ["FP_1"],
        "BarcodeFormatIds_2": ["BF2_NONSTANDARD_BARCODE"]
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds_2": ["BF2_NONSTANDARD_BARCODE"],                          
            "StandardFormat": "BF_CODE_128",    
            "AllModuleDeviation":2          
           
        }
    ], 
    "Version": "3.0"
}

HeadModuleRatio, TailModuleRatio

These parameters specify the exception bars used as the start or stop symbols of a non-standard 1D barcode.

The last parameter AllModuleDeviation handles barcodes consisting of all bars that deviate in the same way. If the bars that make up the start or stop symbol of a barcode have irregular deviations, HeadModuleRatio and TailModuleRatio can be used to specify them.

Just like AllModuleDeviation, you need to set the following parameters to utilize HeadModuleRatio and TailModuleRatio:

  1. FormatSpecification.BarcodeFormatIds_2 should be set to NON_STANDARD_BARCODE, which indicates that the barcode to be read does not strictly follow any standard format.

  2. FormatSpecification.StandardFormat should be set to a standard 1D barcode format such as BF_CODE128 on which DBR applies the deviation.

  3. ImageParameter.BarcodeFormatIds_2 should be set to NON_STANDARD_BARCODE, which means non-standard barcodes are to be read.

The image below is such a non-standard barcode: it has irregular start bars with a ratio of 2:1:1:3:3:1 and irregular stop bars with a ratio of 2:3:3:2:2:2:3.

nonstandard-start-end

If the barcode conforms to the standard (Code Set C), it should have start bars with a ratio of 2:1:1:2:3:2 and stop bars with a ratio of 2:3:3:1:1:1:2 like this:

standard-start-end

The following template demostrates how to use HeadModuleRatio and TailModuleRatio to tell DBR about the irregular start and stop symbols of the barcode:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Read barcodes with irregular start and end symbols.",
        "FormatSpecificationNameArray": ["FP_1"],
        "BarcodeFormatIds_2": ["BF2_NONSTANDARD_BARCODE"] 
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds_2": [                 
                "BF2_NONSTANDARD_BARCODE"
            ],  
            "StandardFormat":"BF_CODE_128", 
            "HeadModuleRatio": "211331",          
            "TailModuleRatio": "2332223", 
            "Code128Subset": "C"                 
        }
    ], 
    "Version": "3.0"
}

StandardFormat

This parameter specifies a standard barcode format based on which a non-standard format is defined. See it in action with the parameters AllModuleDeviation, HeadModuleRatio and TailModuleRatio.

AustralianPostEncodingTable

Australia Post Barcodes contain a segment of customer information that can be decoded using one of two standard-defined decoding tables (CTable, NTable). This parameter is used to specify which table should be used.

Name Description
CTable This table allows A..Z, a..z, 1..9, space and # sign.
NTable This table only allows digits.

This parameter can be set to “C” or “N” and the default value is “C”.

You also need to set FormatSpecification.BarcodeFormatIds_2 to BF2_AUSTRALIANPOST as shown in the template below:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Specify which table to use for interpreting customre information.",
        "FormatSpecificationNameArray": ["FP_1"],
        "BarcodeFormatIds_2": ["BF2_AUSTRALIANPOST"] 
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds_2": [                 
                "BF2_AUSTRALIANPOST"
            ],  
            "AustralianPostEncodingTable": "C"                 
        }
    ], 
    "Version": "3.0"
}

MinQuietZoneWidth

Quiet zone is the blank margin on both sides of the barcode that tells the barcode reader where the barcode symbol starts and stops. Ideally, there should be enough space on both ends. However, real-life barcodes may have thinner margins than expected. To handle this, we can use MinQuietZoneWidth to specify the minimum width of the quiet zone.

barcode-quietzone-definition

Here is a sample image with a very narrow quite zone:

barcode-narrow-wide-quietzone

In this case, we can set MinQuietZoneWidth to 1 or 0:

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Read barcodes with think quiet zone.", 
        "FormatSpecificationNameArray":["FP_1"],
        "DeblurLevel": 1
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds": ["BF_CODE_128"],                
            "MinQuietZoneWidth":1
        }
    ], 
    "Version": "3.0"
}   

ModuleSizeRangeArray

The module size is the width of the thinnest possible bar for 1D barcodes or the width of the smallest building block for a 2D barcode. By default, DBR will try to locate and decode barcodes with any module size. In some cases, you may only be interested in barcodes with certain module sizes. In this case, you can use ModuleSizeRangeArray to specify a range of different module sizes for DBR to use when reading barcodes.

The allowed values range from 0 to 0x7fffffff in pixels.

The template below limits the module size to 10 ~ 100.

{
    "ImageParameter": {
        "Name": "ImageParameter1", 
        "Description": "Limit the module size.", 
        "FormatSpecificationNameArray":["FP_1"]
    }, 
    "FormatSpecificationArray": [
        {
            "Name": "FP_1", 
            "BarcodeFormatIds": [                 
                "BF_CODE_39"
            ], 
            "ModuleSizeRangeArray":[
                {
                  "MaxValue":100,
                  "MinValue":10
                }
            ] 
        }
    ], 
    "Version": "3.0"
}

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 9.x
      • Version 9.2.0
      • Version 9.0.0
    • Version 8.x
      • Version 8.8.0
      • Version 8.6.0
      • Version 8.4.0
      • Version 8.2.0
      • Version 8.1.2
      • Version 8.1.0
      • Version 8.0.0
    • Version 7.x
      • Version 7.6.0
      • Version 7.5.0
    Change +
    © 2003–2023 Dynamsoft. All rights reserved.
    Privacy Statement / Site Map / Home / Purchase / Support