Skip to content

Exposed additional options (marginSize, moduleSize, & fnc1) from dmtxencode.c #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
james-duvall wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Exposed additional options (marginSize, moduleSize, & fnc1) from dmtxencode.c #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions pylibdmtx/pylibdmtx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,8 @@ def _encoder():
dmtxEncodeDestroy(byref(encoder))


def encode(data, scheme=None, size=None):
def encode(data, scheme=None, size=None,
marginSize=None, moduleSize=None, fnc1=None):
"""
Encodes `data` in a DataMatrix image.

Expand All @@ -323,8 +324,16 @@ def encode(data, scheme=None, size=None):
data: bytes instance
scheme: encoding scheme - one of `ENCODING_SCHEME_NAMES`, or `None`.
If `None`, defaults to 'Ascii'.
size: image dimensions - one of `ENCODING_SIZE_NAMES`, or `None`.
size: requested image dimensions - one of `ENCODING_SIZE_NAMES`, or `None`.
If `None`, defaults to 'ShapeAuto'.
marginSize: int (in pixels) or `None`.
If `None`, uses libdmtx default (10 px).
Margin is applied to each edge of the data matrix
moduleSize: int (in pixels) or `None`.
If `None`, uses libdmtx default (5 px).
fnc1: int
Character to represent FNC1 (Function Code 1) or `None`.
If `None`, uses libdmtx default (DmtxUndefined).

Returns:
Encoded: with properties `(width, height, bpp, pixels)`.
Expand Down Expand Up @@ -359,6 +368,13 @@ def encode(data, scheme=None, size=None):
with _encoder() as encoder:
dmtxEncodeSetProp(encoder, DmtxProperty.DmtxPropScheme, scheme)
dmtxEncodeSetProp(encoder, DmtxProperty.DmtxPropSizeRequest, size)
if marginSize:
dmtxEncodeSetProp(encoder, DmtxProperty.DmtxPropMarginSize, marginSize)
if moduleSize:
dmtxEncodeSetProp(encoder, DmtxProperty.DmtxPropModuleSize, moduleSize)
if fnc1:
dmtxEncodeSetProp(encoder, DmtxProperty.DmtxPropFnc1, fnc1)


if dmtxEncodeDataMatrix(encoder, len(data), cast(data, c_ubyte_p)) == 0:
raise PyLibDMTXError(
Expand Down