|

Dynamsoft's Barcode Reader SDK enables you to efficiently embed barcode reading functionality in your web, desktop or mobile application using just a few lines of code. Saving you months of added development time and resources, our SDK can create high-speed and reliable barcode scanner software applications to meet your business needs.

Dynamsoft Barcode Reader's Python Edition comes with all the general features of Dynamsoft Barcode Reader, bringing convenience for customers who develop in Python. In addition, you could refer to the Python samples available in our Github when building your own application. If you have any inquiries about our product, please contact us at support@dynamsoft.com.

• Version
• Supported Python Version
• Supported Platforms
• Installation
• License
• Supported Symbologies
• Release Notes
• Interfaces
  • Enum Interfaces
  • Struct Interfaces
  • Exception Class Interface
  • Main Class Interface
• Appendix
  • Code Snippet
  • Mode Argument List
• Contact Us

• 7.6

• Windows x64

• Linux(x64, ARM32, ARM64)

• macOS (10.15+)

• Python3.6

• Python3.7

• Python3.8

pip install dbr

Apply for a trial license: https://www.dynamsoft.com/CustomerPortal/Portal/Triallicense.aspx

We support all major barcodes symbologies across a variety of industries such as government, finance, retail, warehouse inventory, and healthcare.

• Linear Barcodes (1D) :
  • Code 39 (including Code 39 Extended)
  • Code 93
  • Code 128
  • Codabar
  • Interleaved 2 of 5
  • EAN-8
  • EAN-13
  • UPC-A
  • UPC-E
  • Industrial 2 of 5
• 2D Barcodes :
  • QR Code (including Micro QR Code)
  • Data Matrix
  • PDF417 (including Micro PDF417)
  • Aztec Code
  • MaxiCode (mode 2-5)
• Patch Code
• GS1 Composite Code
• GS1 DataBar :
  • Omnidirectional
  • Truncated
  • Stacked
  • Stacked Omnidirectional
  • Limited
  • Expanded
  • Expanded Stacked
• Postal Codes :
  • USPS Intelligent Mail
  • Postnet
  • Planet
  • Australian Post
  • UK Royal Mail

https://www.dynamsoft.com/Products/Dynamic-Barcode-Reader-News.aspx

Describes the accompanying text recognition mode.

• ATRM_GENERAL : Recognizes accompanying texts using the general algorithm. Check Arguments of AccompanyingTextRecognitionModes for available argument settings.
• ATRM_REV : Reserved setting for accompanying text recognition mode.
• ATRM_SKIP : Skips the accompanying text recognition.

Describes the barcode complement mode.

• BCM_AUTO : Not supported yet.
• BCM_GENERAL : Complements the barcode using the general algorithm.
• BCM_REV : Reserved setting for barcode complement mode.
• BCM_SKIP : Skips the barcode complement.

Describes the barcode colour mode.

• BICM_DARK_ON_LIGHT : Dark items on a light background. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_LIGHT_ON_DARK : Light items on a dark background. Not supported yet. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_DARK_ON_DARK : Dark items on a dark background. Not supported yet. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_LIGHT_ON_LIGHT : Light items on a light background. Not supported yet. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_DARK_LIGHT_MIXED : The background is mixed by dark and light. Not supported yet. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_DARK_ON_LIGHT_DARK_SURROUNDING : Dark item on a light background surrounded by dark. Check Arguments of BarcodeColourModes for available argument settings.
• BICM_REV : Reserved setting for barcode colour mode.
• BICM_SKIP : Skips the barcode colour operation.

Describes the barcode types in BarcodeFormat group 1.

• BF_ALL : All supported formats in BarcodeFormat group 1
• BF_ONED : Combined value of BF_CODABAR, BF_CODE_128, BF_CODE_39, BF_CODE_39_Extended, BF_CODE_93, BF_EAN_13, BF_EAN_8, INDUSTRIAL_25, BF_ITF, BF_UPC_A, BF_UPC_E
• BF_GS1_DATABAR : Combined value of BF_GS1_DATABAR_OMNIDIRECTIONAL, BF_GS1_DATABAR_TRUNCATED, BF_GS1_DATABAR_STACKED, BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, BF_GS1_DATABAR_EXPANDED, BF_GS1_DATABAR_EXPANDED_STACKED, BF_GS1_DATABAR_LIMITED
• BF_CODE_39 : Code 39
• BF_CODE_128 : Code 128
• BF_CODE_93 : Code 93
• BF_CODABAR : Codabar
• BF_ITF : Interleaved 2 of 5
• BF_EAN_13 : EAN-13
• BF_EAN_8 : EAN-8
• BF_UPC_A : UPC-A
• BF_UPC_E : UPC-E
• BF_INDUSTRIAL_25 : Industrial 2 of 5
• BF_CODE_39_EXTENDED : CODE39 Extended
• BF_GS1_DATABAR_OMNIDIRECTIONAL : GS1 Databar Omnidirectional
• BF_GS1_DATABAR_TRUNCATED : GS1 Databar Truncated
• BF_GS1_DATABAR_STACKED : GS1 Databar Stacked
• BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL : GS1 Databar Stacked Omnidirectional
• BF_GS1_DATABAR_EXPANDED : GS1 Databar Expanded
• BF_GS1_DATABAR_EXPANDED_STACKED : GS1 Databar Expaned Stacked
• BF_GS1_DATABAR_LIMITED : GS1 Databar Limited
• BF_PATCHCODE : Patch code
• BF_PDF417 : PDF417
• BF_QR_CODE : QRCode
• BF_DATAMATRIX : DataMatrix
• BF_AZTEC : AZTEC
• BF_MAXICODE : MAXICODE
• BF_MICRO_QR : Micro QR Code
• BF_MICRO_PDF417 : Micro PDF417
• BF_GS1_COMPOSITE : GS1 Composite Code
• BF_NULL : No barcode format in BarcodeFormat group 1

Describes the barcode types in BarcodeFormat group 2.

• BF2_NULL : No barcode format in BarcodeFormat group 2
• BF2_POSTALCODE : Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_NONSTANDARD_BARCODE : Nonstandard barcode
• BF2_USPSINTELLIGENTMAIL : USPS Intelligent Mail. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_POSTNET : Postnet. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_PLANET : Planet. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_AUSTRALIANPOST : Australian Post. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_RM4SCC : Royal Mail 4-State Customer Barcode. When you set this barcode format, the library will automatically add LM_STATISTICS_POSTAL_CODE to LocalizationModes if you doesn't set it.
• BF2_DOTCODE : DotCode. When you set this barcode format, the library will automatically add LM_STATISTICS_MARKS to LocalizationModes if you doesn't set it.

Describes the binarization mode.

• BM_AUTO : Not supported yet.
• BM_LOCAL_BLOCK : Binarizes the image based on the local block. Check Arguments of BinarizationModes for available argument settings.
• BM_THRESHOLD : Performs image binarization based on the givern threshold.Check Arguments of BinarizationModes for available argument settings.
• BM_REV : Reserved setting for binarization mode.
• BM_SKIP : Skips the binarization.

Describes the clarity calculation method.

• ECCM_CONTRAST : Calculates clarity using the contrast method.

Describes the clarity filter mode.

• CFM_GENERAL : The frames using the general algorithm based on calculated clarity.

Describes the colour clustering mode.

• CCM_AUTO : Not supported yet.
• CCM_GENERAL_HSV : Clusters colours using the general algorithm based on HSV. Check Arguments of ColourClusteringModes for available argument settings.
• CCM_REV : Reserved setting for colour clustering mode.
• CCM_SKIP : Skips the colour clustering.

Describes the colour conversion mode.

• CICM_GENERAL : Converts a colour image to a grayscale image using the general algorithm. Check Arguments of ColourConversionModes for available argument settings.
• CICM_REV : Reserved setting for colour conversion mode.
• CICM_SKIP : Skips the colour conversion.

Describes the conflict mode.

• CM_IGNORE : Ignores new settings and inherits the previous settings.
• CM_OVERWRITE : Overwrites the old settings with new settings.

Describes the deformation resisting mode.

• DRM_AUTO : Not supported yet.
• DRM_GENERAL : Resists deformation using the general algorithm. Check Arguments of DeformationResistingModes for available argument settings.
• DRM_REV : Reserved setting for deformation resisting mode.
• DRM_SKIP : Skips deformation resisting.

Describes the DPM code reading mode.

• DPMCRM_AUTO : Not supported yet.
• DPMCRM_GENERAL : Reads DPM code using the general algorithm. Valid only when LM_STATISTICS_MARKS is set. When this mode is set, the library will automatically add LM_STATISTICS_MARKS to LocalizationModes and add a BM_LOCAL_BLOCK to BinarizationModes which is with arguments: BlockSizeX=0, BlockSizeY=0, EnableFillBinaryVacancy=0, ImagePreprocessingModesIndex=1, ThreshValueCoefficient=15 if you doesn't set them.
• DPMCRM_REV : Reserved setting for DPM code reading mode.
• DPMCRM_SKIP : Skips DPM code reading.

Describes error code

Describes the grayscale transformation mode.

• GTM_INVERTED : Transforms to inverted grayscale. Recommended for light on dark images.
• GTM_ORIGINAL : Keeps the original grayscale. Recommended for dark on light images.
• GTM_REV : Reserved setting for grayscale transformation mode.
• GTM_SKIP : Skips grayscale transformation.

Describes the image pixel format.

• IPF_BINARY : 0:Black, 1:White
• IPF_BINARYINVERTED : 0:White, 1:Black
• IPF_GRAYSCALED : 8bit gray
• IPF_NV21 : NV21
• IPF_RGB_565 : 16bit with RGB channel order stored in memory from high to low address
• IPF_RGB_555 : 16bit with RGB channel order stored in memory from high to low address
• IPF_RGB_888 : 24bit with RGB channel order stored in memory from high to low address
• IPF_ARGB_8888 : 32bit with ARGB channel order stored in memory from high to low address
• IPF_RGB_161616 : 48bit with RGB channel order stored in memory from high to low address
• IPF_ARGB_16161616 : 64bit with ARGB channel order stored in memory from high to low address
• IPF_ABGR_8888 : 32bit with ABGR channel order stored in memory from high to low address
• IPF_ABGR_16161616 : 64bit with ABGR channel order stored in memory from high to low address
• IPF_BGR_888 : 24bit with BGR channel order stored in memory from high to low address

Describes the image preprocessing mode.

• IPM_AUTO : Not supported yet.
• IPM_GENERAL : Takes the unpreprocessed image for following operations. Check Arguments of ImagePreprocessingModes for available argument settings.
• IPM_GRAY_EQUALIZE : Preprocesses the image using the gray equalization algorithm. Check Arguments of ImagePreprocessingModes for available argument settings.
• IPM_GRAY_SMOOTH : Preprocesses the image using the gray smoothing algorithm. Check Arguments of ImagePreprocessingModes for available argument settings.
• IPM_SHARPEN_SMOOTH : Preprocesses the image using the sharpening and smoothing algorithm. Check Arguments of ImagePreprocessingModes for available argument settings.
• IPM_MORPHOLOGY : Preprocesses the image using the morphology algorithm. Check Arguments of ImagePreprocessingModes for available argument settings.
• IPM_REV : Reserved setting for image preprocessing mode.
• IPM_SKIP : Skips image preprocessing.

Describes the intermediate result data type.

• IMRDT_IMAGE : Specifies the ImageData
• IMRDT_CONTOUR : Specifies the Contour
• IMRDT_LINESEGMENT : Specifies the LineSegment
• IMRDT_LOCALIZATIONRESULT : Specifies the LocalizationResult
• IMRDT_REGIONOFINTEREST : Specifies the RegionOfInterest
• IMRDT_QUADRILATERAL : Specifies the Quadrilateral

Describes the intermediate result saving mode.

• IRSM_MEMORY : Saves intermediate results in memory.
• IRSM_FILESYSTEM : Saves intermediate results in file system. Check Arguments of IntermediateResultSavingMode for available argument settings.
• IRSM_BOTH : Saves intermediate results in both memory and file system. Check Arguments of IntermediateResultSavingMode for available argument settings.

Describes the intermediate result type.

• IRT_NO_RESULT : No intermediate result
• IRT_ORIGINAL_IMAGE : Original image
• IRT_COLOUR_CLUSTERED_IMAGE : Colour clustered image. Not supported yet.
• IRT_COLOUR_CONVERTED_GRAYSCALE_IMAGE : Colour image converted to grayscale
• IRT_TRANSFORMED_GRAYSCALE_IMAGE : Transformed grayscale image
• IRT_PREDETECTED_REGION : Predetected region
• IRT_PREPROCESSED_IMAGE : Preprocessed image
• IRT_BINARIZED_IMAGE : Binarized image
• IRT_TEXT_ZONE : Text zone
• IRT_CONTOUR : Contour
• IRT_LINE_SEGMENT : Line segment
• IRT_FORM : Form. Not supported yet.
• IRT_SEGMENTATION_BLOCK : Segmentation block. Not supported yet.
• IRT_TYPED_BARCODE_ZONE : Typed barcode zone
• IRT_PREDETECTED_QUADRILATERAL : Predetected quadrilateral

Describes the localization mode.

• LM_AUTO : Not supported yet.
• LM_CONNECTED_BLOCKS : Localizes barcodes by searching for connected blocks. This algorithm usually gives best result and it is recommended to set ConnectedBlocks to the highest priority.
• LM_STATISTICS : Localizes barcodes by groups of contiguous black-white regions. This is optimized for QRCode and DataMatrix.
• LM_LINES : Localizes barcodes by searching for groups of lines. This is optimized for 1D and PDF417 barcodes.
• LM_SCAN_DIRECTLY : Localizes barcodes quickly. This mode is recommended in interactive scenario. Check Arguments of LocalizationModes for available argument settings.
• LM_STATISTICS_MARKS : Localizes barcodes by groups of marks.This is optimized for DPM codes.
• LM_STATISTICS_POSTAL_CODE : Localizes barcodes by groups of connected blocks and lines.This is optimized for postal codes.
• LM_CENTRE : Localizes barcodes from the centre of the image. Check Arguments of LocalizationModes for available argument settings.
• LM_REV : Reserved setting for localization mode.
• LM_SKIP : Skips localization.

Describes the PDF reading mode.

• PDFRM_AUTO : Lets the library choose the reading mode automatically.
• PDFRM_VECTOR : Detects barcode from vector data in PDF file.
• PDFRM_RASTER : Converts the PDF file to image(s) first, then perform barcode recognition.
• PDFRM_REV : Reserved setting for PDF reading mode.

Describes the QR Code error correction level.

• QRECL_ERROR_CORRECTION_H : Error Correction Level H (high)
• QRECL_ERROR_CORRECTION_L : Error Correction Level L (low)
• QRECL_ERROR_CORRECTION_M : Error Correction Level M (medium-low)
• QRECL_ERROR_CORRECTION_Q : Error Correction Level Q (medium-high)

Describes the region predetection mode.

• RPM_AUTO : Lets the library choose an algorithm automatically to detect region.
• RPM_GENERAL : Takes the whole image as a region.
• RPM_GENERAL_RGB_CONTRAST : Detects region using the general algorithm based on RGB colour contrast. Check Arguments of RegionPredetectionModes for available argument settings.
• RPM_GENERAL_GRAY_CONTRAST : Detects region using the general algorithm based on gray contrast. Check Arguments of RegionPredetectionModes for available argument settings.
• RPM_GENERAL_HSV_CONTRAST : Detects region using the general algorithm based on HSV colour contrast. Check Arguments of RegionPredetectionModes for available argument settings.
• RPM_REV : Reserved setting for region predetection mode.
• RPM_SKIP : Skips region detection.

Describes the result coordinate type.

• RCT_PIXEL : Returns the coordinate in pixel value.
• RCT_PERCENTAGE : Returns the coordinate as a percentage.

Describes the extended result type.

• RT_STANDARD_TEXT : Specifies the standard text. This means the barcode value.
• RT_RAW_TEXT : Specifies the raw text. This means the text that includes start/stop characters, check digits, etc.
• RT_CANDIDATE_TEXT : Specifies all the candidate text. This means all the standard text results decoded from the barcode.
• RT_PARTIAL_TEXT : Specifies the partial text. This means part of the text result decoded from the barcode.

Describes the scale up mode.

• SUM_AUTO : The library chooses an interpolation method automatically to scale up.
• SUM_LINEAR_INTERPOLATION : Scales up using the linear interpolation method. Check Arguments of ScaleUpModes for available argument settings.
• SUM_NEAREST_NEIGHBOUR_INTERPOLATION : Scales up using the nearest-neighbour interpolation method. Check Arguments of ScaleUpModes for available argument settings.
• SUM_REV : Reserved setting for scale up mode.
• SUM_SKIP : Skip the scale-up process.

Describes the terminate phase.

• TP_REGION_PREDETECTED : Exits the barcode reading algorithm after the region predetection is done.
• TP_IMAGE_PREPROCESSED : Exits the barcode reading algorithm after the region predetection and image pre-processing is done.
• TP_IMAGE_BINARIZED : Exits the barcode reading algorithm after the region predetection, image pre-processing, and image binarization are done.
• TP_BARCODE_LOCALIZED : Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, and barcode localization are done.
• TP_BARCODE_TYPE_DETERMINED : Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, barcode localization, and barcode type determining are done.
• TP_BARCODE_RECOGNIZED : Exits the barcode reading algorithm after the region predetection, image pre-processing, image binarization, barcode localization, barcode type determining, and barcode recognition are done.

Describes the text assisted correction mode.

• TACM_AUTO : Not supported yet.
• TACM_VERIFYING : Uses the accompanying text to verify the decoded barcode result. Check Arguments of TextAssistedCorrectionMode for available argument settings.
• TACM_VERIFYING_PATCHING : Uses the accompanying text to verify and patch the decoded barcode result. Check Arguments of TextAssistedCorrectionMode for available argument settings.
• TACM_REV : Reserved setting for text assisted correction mode.
• TACM_SKIP : Skips the text assisted correction.

Describes the text filter mode.

• TFM_AUTO : Not supported yet.
• TFM_GENERAL_CONTOUR : Filters text using the general algorithm based on contour. Check Arguments of TextFilterModes for available argument settings.
• TFM_REV : Reserved setting for text filter mode.
• TFM_SKIP : Skips text filtering.

Describes the text result order mode.

- TROM_CONFIDENCE : Returns the text results in descending order by confidence.
- TROM_POSITION : Returns the text results in position order, from top to bottom, then left to right.
- TROM_FORMAT : Returns the text results in alphabetical and numerical order by barcode format string.
- TROM_REV : Reserved setting for text result order mode.
- TROM_SKIP : Skips the result ordering operation.

Describes the texture detection mode.

• TDM_AUTO : Not supported yet.
• TDM_GENERAL_WIDTH_CONCENTRATION : Detects texture using the general algorithm. Check Arguments of TextureDetectionModes for available argument settings.
• TDM_REV : Reserved setting for texture detection mode.
• TDM_SKIP : Skips texture detection.

Stores the sampling image data.

Attributes :

• bytes : The sampling image data in a byte array.
• width : The width of the sampling image.
• height : The height of the sampling image.

Defines a class to configure the frame decoding Parameters.

Attributes :

• max_queue_length : The maximum number of frames waiting for decoding.
• max_result_queue_length : The maximum number of frames waiting results (text result/localization result) will be kept for further reference.
• width : The width of the frame image in pixels.
• height : The height of the frame image in pixels.
• stride : The stride (or scan width) of the frame image.
• image_pixel_format : The image pixel format used in the image byte array.
• region_top : The region definition of the frame to calculate the internal indicator.The top-most coordinate or percentage of the region.
• region_left : The region definition of the frame to calculate the internal indicator.The left-most coordinate or percentage of the region.
• region_right : The region definition of the frame to calculate the internal indicator.The right-most coordinate or percentage of the region.
• region_bottom : The region definition of the frame to calculate the internal indicator.The bottom-most coordinate or percentage of the region.
• region_measured_by_percentage : Sets whether or not to use percentage to measure the region size.
• threshold : The threshold used for filtering frames.
• fps : The frequency of calling AppendFrame() per second.
• auto_filter : Sets whether to filter frames automatically.
• clarity_calculation_method : Sets the method used for calculating the clarity of the frames.
• clarity_filter_mode : Sets the mode used for filtering frames by calculated clarity.

Defines a struct to configure the barcode reading runtime settings. These settings control the barcode recognition process such as which barcode types to decode.

Attributes :

• terminate_phase : Sets the phase to stop the barcode reading algorithm.
• timeout : Sets the maximum amount of time (in milliseconds) that should be spent searching for a barcode per page. It does not include the time taken to load/decode an image (TIFF, PNG, etc.) from disk into memory.
• max_algorithm_thread_count : Sets the number of threads the image processing algorithm will use to decode barcodes.
• expected_barcodes_count : Sets the number of barcodes expected to be detected for each image.
• barcode_format_ids : Sets the formats of the barcode in BarcodeFormat group 1 to be read. Barcode formats in BarcodeFormat group 1 can be combined.
• barcode_format_ids_2 : Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 2 can be combined.
• pdf_raster_dpi : Sets the output image resolution.
• scale_down_threshold : Sets the threshold for the image shrinking.
• binarization_modes : Sets the mode and priority for binarization.
• localization_modes : Sets the mode and priority for localization algorithms.
• colour_clustering_modes : Sets the mode and priority for colour categorization. Not supported yet.
• colour_conversion_modes : Sets the mode and priority for converting a colour image to a grayscale image.
• grayscale_transformation_modes : Sets the mode and priority for the grayscale image conversion.
• region_predetection_modes : Sets the region pre-detection mode for barcodes search.
• image_preprocessing_modes : Sets the mode and priority for image preprocessing algorithms.
• texture_detection_modes : Sets the mode and priority for texture detection.
• text_filter_modes : Sets the mode and priority for text filter.
• dpm_code_reading_modes : Sets the mode and priority for DPM code reading.
• deformation_resisting_modes : Sets the mode and priority for deformation resisting.
• barcode_complement_modes : Sets the mode and priority to complement the missing parts in the barcode.
• barcode_colour_modes : Sets the mode and priority for the barcode colour mode used to process the barcode zone.
• accompanying_text_recognition_modes : Sets the mode and priority to recognize accompanying text.
• text_result_order_modes : Sets the mode and priority for the order of the text results returned.
• scale_up_modes : Sets the mode and priority to control the sampling methods of scale-up for linear barcode with small module sizes.
• text_assisted_correction_mode : Sets the mode of text assisted correction for barcode decoding. Not supported yet.
• intermediate_result_saving_mode : Sets the mode for saving intermediate result.
• deblur_level : Sets the degree of blurriness of the barcode.
• intermediate_result_types : Sets which types of intermediate result to be kept for further reference. Intermediate result types can be combined.
• result_coordinate_type : Specifies the format for the coordinates returned.
• return_barcode_zone_clarity : Sets whether or not to return the clarity of the barcode zone.
• region_top : The top-most coordinate or percentage of the region.
• region_bottom : The bottom-most coordinate or percentage of the region.
• region_left : The left-most coordinate or percentage of the region.
• region_right : The right-most coordinate or percentage of the region.
• region_measured_by_percentage : Sets whether or not to use percentage to measure the region size.
• min_barcode_text_length : Sets the range of barcode text length for barcodes search.
• min_result_confidence : The minimum confidence of the result.
• pdf_reading_mode : Sets the way to detect barcodes from a PDF file when using the DecodeFile method.

Stores the OneD code details.

Attributes :

• module_size : The barcode module size (the minimum bar width in pixel)
• start_chars_bytes : The start chars in a byte array
• stop_chars_bytes : The stop chars in a byte array
• check_digit_bytes : The check digit chars in a byte array
• start_pattern_range : The position of the start pattern relative to the barcode location. Index 0 : X coordinate of the start position in percentage value; Index 1 : X coordinate of the end position in percentage value.
• middle_pattern_range : The position of the middle pattern relative to the barcode location. Index 0 : X coordinate of the start position in percentage value; Index 1 : X coordinate of the end position in percentage value.
• end_pattern_range : The position of the end pattern relative to the barcode location. Index 0 : X coordinate of the start position in percentage value; Index 1 : X coordinate of the end position in percentage value.

Stores the QRCode details.

Attributes :

• module_size : The barcode module size (the minimum bar width in pixel)
• rows : The row count of the barcode
• columns : The column count of the barcode
• error_correction_level : The error correction level of the barcode
• versions : The version of the QR Code
• model : Number of the models

Stores the DataMatrix details.

Attributes :

• module_size : The barcode module size (the minimum bar width in pixel)
• rows : The row count of the barcode
• columns : The column count of the barcode
• data_region_rows : The data region row count of the barcode
• data_region_columns : The data region column count of the barcode
• data_region_number : The data region count

Stores the PDF details.

Attributes :

• module_size : The barcode module size (the minimum bar width in pixel)
• rows : The row count of the barcode
• columns : The column count of the barcode
• error_correction_level : The error correction level of the barcode

Stores the Aztec details.

Attributes :

• module_size : The barcode module size (the minimum bar width in pixel)
• rows : The row count of the barcode
• columns : The column count of the barcode
• layer_number : A negative number (-1, -2, -3, -4) specifies a compact Aztec code. A positive number (1, 2, .. 32) specifies a normal (full-rang) Aztec code.

Stores the extended result.

Attributes :

• result_type : Extended result type
• barcode_format : Barcode type in BarcodeFormat group 1
• barcode_format_string : Barcode type in BarcodeFormat group 1 as string
• barcode_format_2 : Barcode type in BarcodeFormat group 2
• barcode_format_string_2 : Barcode type in BarcodeFormat group 2 as string
• confidence : The confidence of the result
• bytes : The content in a byte array
• accompanying_text_bytes : The accompanying text content in a byte array
• deformation : The deformation value
• detailed_result : One of the following: OnedDetailedResult, PDFDetailedResult, DataMatrixDetailedResult, AztecDetailedResult, QRCodeDetailedResult
• sampling_image : The sampling image info
• clarity : The clarity of the barcode zone in percentage.

Stores the localization result.

Attributes :

• terminate_phase : The terminate phase of localization result
• barcode_format : Barcode type in BarcodeFormat group 1
• barcode_format_string : Barcode type in BarcodeFormat group 1 as string
• barcode_format_2 : Barcode type in BarcodeFormat group 2
• barcode_format_string_2 : Barcode type in BarcodeFormat group 2 as string
• localization_points : Extended result type
• result_type : The 4 localization points
• angle : The angle of a barcode. Values range is from 0 to 360
• module_size : The barcode module size (the minimum bar width in pixel)
• page_number : The page number the barcode located in. The index is 0-based
• region_name : The region name the barcode located in
• document_name : The document name
• result_coordinate_type : The coordinate type
• accompanying_text_bytes : The accompanying text content in a byte array
• confidence : The confidence of the localization result

Stores the text result.

Attributes :

• barcode_format : Barcode type in BarcodeFormat group 1
• barcode_format_string : Barcode type in BarcodeFormat group 1 as string
• barcode_format_2 : Barcode type in BarcodeFormat group 2
• barcode_format_string_2 : Barcode type in BarcodeFormat group 2 as string
• barcode_text : The barcode text
• barcode_bytes : The barcode content in a byte array
• localization_result : The corresponding localization result
• detailed_result : One of the following: OnedDetailedResult, PDFDetailedResult, DataMatrixDetailedResult, AztecDetailedResult, QRCodeDetailedResult
• extended_results : The extended result list

Stores an x- and y-coordinate pair in two-dimensional space.

Attributes :

• x : The X coordinate of the point
• y : The Y coordinate of the point

Stores the image data.

Attributes :

• bytes : The image data content in a byte array
• width : The width of the image in pixels
• height : The height of the image in pixels
• stride : The image data content in a byte array
• image_pixel_format : The image data content in a byte array

Stores the contour.

Attributes :

• points : The points list

Stores line segment data.

Attributes :

• start_point : The start point of the line segment
• end_point : The end point of the line segment
• lines_confidence_coefficients : The end point of the line segment

Stores the region of interest.

Attributes :

• roi_id : The ID generated by the SDK
• point : The left top point of the region
• width : The width of the region
• height : The height of the region

Stores the quadrilateral.

Attributes :

• points : Four vertexes in a clockwise direction of a quadrilateral. Index 0 represents the left-most vertex.

Stores the intermediate result.

Attributes :

• data_type : The data type of the intermediate result
• results : One of the following types: List of class Contour, List of class ImageData, List of class LineSegment, List of class LocalizationResult, List of class RegionOfInterest, List of class Quadrilateral
• result_type : Intermediate result type
• barcode_complement_mode : The BarcodeComplementMode used when generating the current intermediate result
• bcm_index : The list index of current used ColourClusteringMode in the ColourClusteringModes setting
• deformation_resisting_mode : The DeformationResistingMode used when generating the current intermediate result
• drm_index : The list index of current used DeformationResistingMode in the DeformationResistingModes setting
• dpm_code_reading_mode : The DPMCodeReadingMode used when generating the current intermediate result
• dpmcrm_index : The list index of current used DPMCodeReadingMode in the DPMCodeReadingModes setting
• text_filter_mode : The TextFilterMode used when generating the current intermediate result
• tfm_index : The list index of current used TextFilterMode in the TextFilterModes setting
• localization_mode : The LocalizationMode used when generating the current intermediate result
• lm_index : The list index of current used LocalizationMode in the LocalizationModes setting
• binarization_mode : The BinarizationMode used when generating the current intermediate result
• bm_index : The list index of current used BinarizationMode in the BinarizationModes setting
• image_preprocessing_mode : The ImagePreprocessingMode used when generating the current intermediate result
• ipm_index : The list index of current used ImagePreprocessingMode in the ImagePreprocessingModes setting
• region_predetection_mode : The RegionPredetectionMode used when generating the current intermediate result
• rpm_index : The list index of current used RegionPredetectionMode in the RegionPredetectionModes setting
• grayscale_transformation_mode : The GrayscaleTransformationMode used when generating the current intermediate result
• gtm_index : The list index of current used GrayscaleTransformationMode in the GrayscaleTransformationModes setting
• colour_conversion_mode : The ColourConversionMode used when generating the current intermediate result
• cicm_index : The list index of current used ColourConversionMode in the ColourConversionModes setting
• colour_clustering_mode : The ColourClusteringMode used when generating the current intermediate result
• ccm_index : The list index of current used ColourClusteringMode in the ColourClusteringModes setting
• rotation_matrix : The rotation matrix
• roi_id : The ID of the ROI (Region Of Interest) generated by the SDK. -1 means the original image.
• scale_down_ratio : The scale down ratio
• frame_id : The ID of the operated frame
• rpm_colour_argument_index : The index of ForeAndBackgroundColour argument used for RegionPredetectionMode

• BarcodeReaderError

• BarcodeReader : Defines a class that provides functions for decoding barcodes in images. This is the main interface for recognizing barcodes.

  • Attributes:

    • version : The Dynamsoft Barcode Reader - Python Edition version
    • dbr_version : The Dynamsoft Barcode Reader version

  • Methods :

    • get_error_string(error_code)

      • @description Gets the detailed error message by error code
      • @param error_code : Error code
      • @return error_string : The detailed error message

    • init_license(dbr_license)

      • @description Reads product key and activates the SDK.
      • @param dbr_license : The product keys
      • @return error : error_code = error[0], error_message = error[1].

    • init_license_from_server(license_server, license_key)

      • @description Initializes barcode reader license and connects to the specified server for online verification.
      • @param license_server : The name/IP of the license server.
      • @param license_key : The license key.
      • @return error : error_code = error[0], error_message = error[1].

    • init_license_from_license_content(license_key, license_content)

      • @description Initializes barcode reader license from the license content on the client machine for offline verification.
      • @param license_key : The license key.
      • @param license_content : An encrypted string representing the license content (quota, expiration date, barcode type, etc.) obtained from the method output_license_to_string().
      • @return error : error_code = error[0], error_message = error[1].

    • output_license_to_string()

      • @description Outputs the license content as an encrypted string from the license server to be used for offline license verification.
      • @return license_string : An encrypted string which stores the content of license.
      • @exception BarcodeReaderError

    • get_runtime_settings()

      • @description Gets current runtime settings.
      • @return runtime_settings : The PublicRuntimeSetting object of current runtime settings.

    • update_runtime_settings(settings)

      • @description Update runtime settings with a PublicRuntimeSetting object.
      • @param settings : a PublicRuntimeSetting object.
      • @exception BarcodeReaderError

    • reset_runtime_settings(settings)

      • @description Resets all parameters to default values.

    • set_mode_argument(modes_name, index, argument_name, argument_value)

      • @description Sets the optional argument for a specified mode in Modes(Mode) parameters. Check Mode Argument List for available argument settings.
      • @param modes_name : The modes(mode) parameter name to set argument.
      • @param index : The array index of modes parameter to indicate a specific mode.
      • @param argument_name : The name of the argument to set.
      • @param argument_value : The value of the argument to set.
      • @return error : error_code = error[0], error_message = error[1].

    • get_mode_argument(modes_name, index, argument_name)

      • @description Gets the optional argument for a specified mode in Modes(Mode) parameters.Check Mode Argument List for available argument settings.
      • @param modes_name : The modes(mode) parameter name to get argument.
      • @param index : The array index of modes parameter to indicate a specific mode.
      • @param argument_name : The name of the argument to get.
      • @return argument_value : The value of the argument to get.
      • @exception BarcodeReaderError

    • init_runtime_settings_with_string(json_string, conflict_mode=EnumConflictMode.CM_OVERWRITE)

      • @description Initializes runtime settings with the parameters obtained from a JSON string.
      • @param json_string : A JSON string that represents the content of the settings.
      • @param conflict_mode : The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings with the new template.
      • @return error : error_code = error[0], error_message = error[1].

    • init_runtime_settings_with_file(json_file, conflict_mode=EnumConflictMode.CM_OVERWRITE)

      • @description Initializes runtime settings with the parameters obtained from a JSON file.
      • @param json_file : A JSON template file.
      • @param conflict_mode : The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings with the new template.
      • @return error : error_code = error[0], error_message = error[1].

    • append_template_string_to_runtime_settings(json_string, conflict_mode)

      • @description Appends a new template string to the current runtime settings.
      • @param json_string : A JSON string that represents the content of the settings.
      • @param conflict_mode : The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings with the new template.
      • @return error : error_code = error[0], error_message = error[1].

    • append_template_file_to_runtime_settings(json_file, conflict_mode)

      • @description Appends a new template file to the current runtime settings.
      • @param json_file : A JSON template file.
      • @param conflict_mode : The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings with the new template.
      • @return error : error_code = error[0], error_message = error[1].

    • output_settings_to_json_string()

      • @description Outputs runtime settings to a json string.
      • @return settings_string : The output string which stores the contents of current settings.

    • output_settings_to_json_file(save_file_path)

      • @description Outputs runtime settings and save them into a settings file (JSON file).
      • @param save_file_path : The path of the output file which stores current settings.
      • @return error : error_code = error[0], error_message = error[1].

    • get_all_template_names()

      • @description Gets all parameter template names.
      • @return template_names <list[str]> : all parameter template names

    • decode_file(image_file_name, template_name="")

      • @description Decodes barcodes in the specified image file.
      • @param image_file_name : A string defining the file name.
      • @param template_name : The template name.
      • @return text_results <list[class TextResult]> : All text results.
      • @exception BarcodeReaderError

    • decode_buffer(image, image_pixel_format=EnumImagePixelFormat.IPF_RGB_888, template_name="")

      • @description Decodes barcodes from the memory buffer containing image pixels in defined format.
      • @param image : The image which is processed by opencv.
      • @param image_pixel_format : The image pixel format used in the image byte array.
      • @param template_name : The template name.
      • @return text_results <list[class TextResult]> : All text results.
      • @exception BarcodeReaderError

    • decode_buffer_manually(self, buffer, width, height, stride, image_pixel_format, template_name="")

      • @description Decodes barcodes from the memory buffer containing image pixels in defined format.
      • @param buffer : The array of bytes which contain the image data.
      • @param width : The width of the image in pixels.
      • @param height : The height of the image in pixels.
      • @param stride : The stride (or scan width) of the image.
      • @param image_pixel_format : The image pixel format used in the image byte array.
      • @param template_name(optional) : The template name.
      • @return text_results <list[class TextResult]> : All text results.
      • @exception BarcodeReaderError : If error happens, this function will throw a BarcodeReaderError exception that can report the detailed error message.

    • decode_file_stream(file_stream, template_name="")

      • @description Decodes barcodes from an image file in memory.
      • @param file_stream : The image file bytes in memory.
      • @return text_results <list[class TextResult]> : All text results.
      • @exception BarcodeReaderError

    • get_all_intermediate_results()

      • @description Returns intermediate results containing the original image, the colour clustered image, the binarized image, contours, lines, text blocks, etc.
      • @return intermediate_results <liset[class IntermediateResult]> : All intermediate results.

    • init_frame_decoding_parameters()

      • @description Init frame decoding parameters.
      • @return frame_decoding_parameters : The frame decoding parameters.

    • start_video_mode(frame_decoding_parameters, call_back_func, template_name="")

      • @description Starts a new thread to decode barcodes from the inner frame queue.
      • @param frame_decoding_parameters : The frame decoding parameters. You can get it by init_frame_decoding_parameters(), then modify its attributes value.
      • @param call_back_func : Sets callback function to process text results generated during frame decoding.
      • @param template_name : The template name.
      • @exception BarcodeReaderError

    • append_video_frame(video_frame)

      • @description Appends a video frame to the inner frame queue.
      • @param video_frame : Gets by opencv.
      • @return frame_id : Current frame id.

    • stop_video_mode()

      • @description Stops the frame decoding thread created by start_video_mode().
      • @exception BarcodeReaderError

    • get_length_of_frame_queue()

      • @description Gets current length of the inner frame queue.
      • @return frame_queue_length : The length of the inner frame queue.

import os
import sys
import cv2
import json
from typing import List
from dbr import *

# you can replace the following variables' value with yours.
license_key = "Input your own license"
#license_server = "Input the name/IP of the license server"
json_file = r"Please input your own template path"
image = r"Please input your own image path"

reader = BarcodeReader()

reader.init_license(license_key)
#reader.init_license_from_server(license_server, license_key)
#license_content = reader.output_license_to_string()
#reader.init_license_from_license_content(license_key, license_content)

error = reader.init_runtime_settings_with_file(json_file)
if error[0] != EnumErrorCode.DBR_OK:
    print(error[1])

if sys.version_info.major == 3 and sys.version_info.minor >= 6:

    try:
        text_results:List[TextResult] = reader.decode_file(image)

        if text_results != None:
            for text_result in text_results:
                print("Barcode Format :")
                print(text_result.barcode_format_string)
                print("Barcode Text :")
                print(text_result.barcode_text)
                print("Localization Points : ")
                print(text_result.localization_result.localization_points)
                print("-------------")
    except BarcodeReaderError as bre:
        print(bre)

else:
    try:
        text_results = reader.decode_file(image)

        if text_results != None:
            for text_result in text_results:
                print("Barcode Format :")
                print(text_result.barcode_format_string)
                print("Barcode Text :")
                print(text_result.barcode_text)
                print("Localization Points : ")
                print(text_result.localization_result.localization_points)
                print("-------------")
    except BarcodeReaderError as bre:
        print(bre)

You can refer to this list when you use set_mode_argument() or get_mode_argument().

support@dynamsoft.com