qrinput.h

Go to the documentation of this file.

/*
 * qrencode - QR Code encoder
 *
 * Input data chunk class
 * Copyright (C) 2006-2017 Kentaro Fukuchi <kentaro@fukuchi.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
 
#ifndef QRINPUT_H
#define QRINPUT_H
 
#include "qrencode.h"
#include "bitstream.h"
 
int QRinput_isSplittableMode(QRencodeMode mode);
 
/******************************************************************************
 * Entry of input data
 *****************************************************************************/
typedef struct _QRinput_List QRinput_List;
 
struct _QRinput_List {
    QRencodeMode mode;
    int size;            ///< Size of data chunk (byte).
    unsigned char *data; ///< Data chunk.
    BitStream *bstream;
    QRinput_List *next;
};
 
/******************************************************************************
 * Input Data
 *****************************************************************************/
struct _QRinput {
    int version;
    QRecLevel level;
    QRinput_List *head;
    QRinput_List *tail;
    int mqr;
    int fnc1;
    unsigned char appid;
};
 
/******************************************************************************
 * Structured append input data
 *****************************************************************************/
typedef struct _QRinput_InputList QRinput_InputList;
 
struct _QRinput_InputList {
    QRinput *input;
    QRinput_InputList *next;
};
 
struct _QRinput_Struct {
    int size; ///< number of structured symbols
    int parity;
    QRinput_InputList *head;
    QRinput_InputList *tail;
};
 
/**
 * Pack all bit streams padding bits into a byte array.
 * @param input input data.
 * @return padded merged byte stream
 */
extern unsigned char *QRinput_getByteStream(QRinput *input);
 
 
extern int QRinput_estimateBitsModeNum(int size);
extern int QRinput_estimateBitsModeAn(int size);
extern int QRinput_estimateBitsMode8(int size);
extern int QRinput_estimateBitsModeKanji(int size);
 
extern QRinput *QRinput_dup(QRinput *input);
 
extern const signed char QRinput_anTable[128];
 
/**
 * Look up the alphabet-numeric convesion table (see JIS X0510:2004, pp.19).
 * @param __c__ character
 * @return value
 */
#define QRinput_lookAnTable(__c__) \
    ((__c__ & 0x80)?-1:QRinput_anTable[(int)__c__])
 
/**
 * Length of a standard mode indicator in bits.
 */
 
#define MODE_INDICATOR_SIZE 4
 
/**
 * Length of a segment of structured-append header.
 */
#define STRUCTURE_HEADER_SIZE 20
 
/**
 * Maximum number of symbols in a set of structured-appended symbols.
 */
#define MAX_STRUCTURED_SYMBOLS 16
 
#ifdef WITH_TESTS
extern int QRinput_mergeBitStream(QRinput *input, BitStream *bstream);
extern int QRinput_getBitStream(QRinput *input, BitStream *bstream);
extern int QRinput_estimateBitStreamSize(QRinput *input, int version);
extern int QRinput_splitEntry(QRinput_List *entry, int bytes);
extern int QRinput_estimateVersion(QRinput *input);
extern int QRinput_lengthOfCode(QRencodeMode mode, int version, int bits);
extern int QRinput_insertStructuredAppendHeader(QRinput *input, int size, int index, unsigned char parity);
#endif
 
#endif /* QRINPUT_H */