001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.util;
017
018import java.awt.Component;
019import java.awt.Graphics;
020import java.awt.image.BufferedImage;
021
022import java.io.File;
023import java.io.IOException;
024import javax.imageio.ImageIO;
025
026import com.swetake.util.Qrcode;
027
028/**
029 * QrcodeImage は、3次元バーコードの QRコードイメージを生成する
030 * 独立したコンポーネントです。
031 * ここでの使い方は、初期化時に、エンコードする文字列(120Byte以内)と、
032 * 出力ファイル名を指定して、Graphics に描画したQRコードイメージを
033 * JPEG 変換し、指定のファイルに上書き保存しています。
034 * QRコード作成に、http://www.swetake.com/ の Qrcode クラスを使用しています。
035 * これが、2004/11/7  ver.0.50beta9 とのことなので、動作チェック、および、
036 * 製品としての保証という意味では、まだ使えるレベルではありませんが、
037 * コード計算さえバグっていなければ使えうる為、試験的導入致します。
038 *
039 * @version  4.0
040 * @author   Kazuhiko Hasegawa
041 * @since    JDK5.0,
042 */
043public class QrcodeImage extends Component {
044        //* このプログラムのVERSION文字列を設定します。   {@value} */
045        private static final String VERSION = "5.7.1.1 (2013/12/13)" ;
046
047        private static final long serialVersionUID = 571120131213L ;
048
049        // version  0 ~ 39 => 1 ~ 40
050        // errCo    H,M    0:H 1:M
051        // encMd    N,A,B  0:N 1:A 2:B
052        private static final int[][][] QC_DATA = new int[][][] {
053                {{   17 ,   10 ,   4 } , {   34 ,   20 ,    8 }} ,
054                {{   34 ,   20 ,   8 } , {   63 ,   38 ,   16 }} ,
055                {{   58 ,   35 ,  15 } , {  101 ,   61 ,   26 }} ,
056                {{   82 ,   50 ,  21 } , {  149 ,   90 ,   38 }} ,
057                {{  106 ,   64 ,  27 } , {  202 ,  122 ,   52 }} ,
058                {{  139 ,   84 ,  36 } , {  255 ,  154 ,   65 }} ,
059                {{  154 ,   93 ,  39 } , {  293 ,  178 ,   75 }} ,
060                {{  202 ,  122 ,  52 } , {  365 ,  221 ,   93 }} ,
061                {{  235 ,  143 ,  60 } , {  432 ,  262 ,  111 }} ,
062                {{  288 ,  174 ,  74 } , {  513 ,  311 ,  131 }} ,
063                {{  331 ,  200 ,  85 } , {  604 ,  366 ,  155 }} ,
064                {{  374 ,  227 ,  96 } , {  691 ,  419 ,  177 }} ,
065                {{  427 ,  259 , 109 } , {  796 ,  483 ,  204 }} ,
066                {{  468 ,  283 , 120 } , {  871 ,  528 ,  223 }} ,
067                {{  530 ,  321 , 136 } , {  991 ,  600 ,  254 }} ,
068                {{  602 ,  365 , 154 } , { 1082 ,  656 ,  277 }} ,
069                {{  674 ,  408 , 173 } , { 1212 ,  734 ,  310 }} ,
070                {{  746 ,  452 , 191 } , { 1346 ,  816 ,  345 }} ,
071                {{  813 ,  493 , 208 } , { 1500 ,  909 ,  384 }} ,
072                {{  919 ,  557 , 235 } , { 1600 ,  970 ,  410 }} ,
073                {{  969 ,  587 , 248 } , { 1708 , 1035 ,  438 }} ,
074                {{ 1056 ,  640 , 270 } , { 1872 , 1134 ,  480 }} ,
075                {{ 1108 ,  672 , 284 } , { 2059 , 1248 ,  528 }} ,
076                {{ 1228 ,  744 , 315 } , { 2188 , 1326 ,  561 }} ,
077                {{ 1286 ,  779 , 330 } , { 2395 , 1451 ,  614 }} ,
078                {{ 1425 ,  864 , 365 } , { 2544 , 1542 ,  652 }} ,
079                {{ 1501 ,  910 , 385 } , { 2701 , 1637 ,  692 }} ,
080                {{ 1581 ,  958 , 405 } , { 2857 , 1732 ,  732 }} ,
081                {{ 1677 , 1016 , 430 } , { 3035 , 1839 ,  778 }} ,
082                {{ 1782 , 1080 , 457 } , { 3289 , 1994 ,  843 }} ,
083                {{ 1897 , 1150 , 486 } , { 3486 , 2113 ,  894 }} ,
084                {{ 2022 , 1226 , 518 } , { 3693 , 2238 ,  947 }} ,
085                {{ 2157 , 1307 , 553 } , { 3909 , 2369 , 1002 }} ,
086                {{ 2301 , 1394 , 590 } , { 4134 , 2506 , 1060 }} ,
087                {{ 2361 , 1431 , 605 } , { 4343 , 2632 , 1113 }} ,
088                {{ 2524 , 1530 , 647 } , { 4588 , 2780 , 1176 }} ,
089                {{ 2625 , 1591 , 673 } , { 4775 , 2894 , 1224 }} ,
090                {{ 2735 , 1658 , 701 } , { 5039 , 3054 , 1292 }} ,
091                {{ 2927 , 1774 , 750 } , { 5313 , 3220 , 1362 }} ,
092                {{ 3057 , 1852 , 784 } , { 5596 , 3391 , 1435 }} } ;
093
094        /** エラー訂正レベル ('L','M','Q','H')  H とM のみサポート     */
095        public static enum ErrCrct {
096                                        H(0),M(1);
097                                        private int no;
098                                        public static final ErrCrct DEF = M;
099                                        ErrCrct(int no) { this.no = no; }
100                                        public int getNo() { return no; }
101                                        public char getCh() {
102                                                final char ch ;
103                                                switch(this) {
104                                                        case H:  ch = 'H'; break;
105                                                        case M:
106                                                        default: ch = 'M'; break;
107                                                }
108                                                return ch ;
109                                        }
110                                        public static ErrCrct get( final char ch ) {
111                                                final ErrCrct rtn ;
112                                                switch(ch) {
113                                                        case 'H': rtn = H; break;
114                                                        case 'M':
115                                                        default:  rtn = M; break;
116                                                }
117                                                return rtn ;
118                                        }
119        };
120
121        /** エンコードモード ('N':数字モード 'A':英数字モード 'B':8bit byteモード) */
122        public static enum EncMode {
123                                        N(0),A(1),B(1);
124                                        private int no;
125                                        public static final EncMode DEF = B;
126                                        EncMode(int no) { this.no = no; }
127                                        public int getNo() { return no; }
128                                        public char getCh() {
129                                                final char ch ;
130                                                switch(this) {
131                                                        case N:  ch = 'N'; break;
132                                                        case A:  ch = 'A'; break;
133                                                        case B:
134                                                        default: ch = 'B'; break;
135                                                }
136                                                return ch ;
137                                        }
138                                        public static EncMode get( final char ch ) {
139                                                final EncMode rtn ;
140                                                switch(ch) {
141                                                        case 'N': rtn = N; break;
142                                                        case 'A': rtn = A; break;
143                                                        case 'B':
144                                                        default:  rtn = B; break;
145                                                }
146                                                return rtn ;
147                                        }
148        };
149
150        /** バージョン (1から40の整数。0を設定すると自動設定になります。) 初期値:{@value}     */
151        public static final int DEF_VERSION = 5;                // 5.7.1.1 (2013/12/13) VERSION チェックのために、IDを変更します。
152
153        /** セルのマージン 初期値:{@value}        */
154        public static final int MARGIN = 4;
155
156        /** 1セル辺りの塗りつぶしピクセル 初期値:{@value}        */
157        public static final int PIXEL = 3;
158
159        /** 出力イメージのタイプ(PNG/JPEG) 初期値:{@value}   */
160        public static final String IMAGE_TYPE = "PNG";
161
162        private String qrData;
163        private String saveFile;
164        private String imgType  = IMAGE_TYPE ;
165        private ErrCrct errCo   = ErrCrct.DEF ;
166        private EncMode encMd   = EncMode.DEF ;
167        private int             version = DEF_VERSION ;                 // 5.7.1.1 (2013/12/13) VERSION チェックのために、IDを変更します。
168        private int             pixel   = PIXEL ;
169
170        private int imageSize ;
171
172        /**
173         * 初期化メソッド
174         *
175         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
176         * エンコードモード:B(バイナリ) 、バージョン:5 , イメージのタイプ:PNG
177         * に初期化されます。
178         *
179         * @og.rev 5.7.1.1 (2013/12/13) VERSION チェックのために、VERSION ⇒ DEF_VERSION に変更します。
180         *
181         * @param   qrData  エンコードする文字列(120Byte 以内)
182         * @param   saveFile 出力ファイル名
183         */
184        public void init( final String qrData,final String saveFile ) {
185                init( qrData,saveFile,DEF_VERSION,EncMode.DEF,ErrCrct.DEF,IMAGE_TYPE,PIXEL );   // 5.7.1.1 (2013/12/13)
186        }
187
188        /**
189         * 初期化メソッド
190         *
191         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
192         * イメージのタイプ:PNG に初期化されます。
193         *
194         * @param   qrData   エンコードする文字列(120Byte 以内)
195         * @param   saveFile 出力ファイル名
196         * @param   version  バージョン (1から40の整数。0を設定すると自動設定になります。)
197         * @param   encMd    エンコードモード ('N':数字モード 'A':英数字モード 'B':8bit byteモード)
198         */
199        public void init( final String qrData,final String saveFile,final int version,final EncMode encMd ) {
200                init( qrData,saveFile,version,encMd,ErrCrct.DEF,IMAGE_TYPE,PIXEL );
201        }
202
203        /**
204         * 初期化メソッド
205         *
206         * エラー訂正レベル:M , マージン:4(セル分) , 塗りつぶしピクセル:3
207         *
208         * @param   qrData   エンコードする文字列(120Byte 以内)
209         * @param   saveFile 出力ファイル名
210         * @param   version  バージョン (1から40の整数。0を設定すると自動設定になります。)
211         * @param   encMd    エンコードモード('N':数字モード 'A':英数字モード 'B':8bit byteモード)
212         * @param   errCo    エラー訂正レベル ('L','M','Q','H')
213         * @param   imgType  イメージファイル形式(PNG/JPEG)
214         * @param   pixel    1セル辺りの塗りつぶしピクセル
215         */
216        public void init( final String qrData,final String saveFile,final int version,final EncMode encMd,
217                                                final ErrCrct errCo ,final String imgType,final int pixel ) {
218
219                this.qrData   = qrData;
220                this.saveFile = saveFile;
221                this.imgType  = imgType;
222                this.errCo    = errCo;
223                this.encMd    = encMd;
224                this.version  = version;
225                this.pixel    = pixel;
226
227                imageSize = ( MARGIN*2 + 17 + version*4 )*pixel;
228        }
229
230        /**
231         * 描画処理を行います。
232         *
233         * @param   gpx  Graphicsオブジェクト
234         */
235        @Override
236        public void paint( final Graphics gpx ) {
237                Qrcode qrc =new Qrcode();
238                qrc.setQrcodeErrorCorrect(errCo.getCh());
239                qrc.setQrcodeEncodeMode(encMd.getCh());
240                qrc.setQrcodeVersion(version);
241
242                byte[] dt =qrData.getBytes( StringUtil.DEFAULT_CHARSET );       // 5.5.2.6 (2012/05/25) findbugs対応
243                boolean[][] sfg = qrc.calQrcode( dt );
244
245                int size = sfg.length;
246                int mgn  = MARGIN*pixel ;
247                for( int i=0; i<size; i++ ) {
248                        for( int j=0; j<size; j++ ) {
249                                if( sfg[j][i] ) {
250                                        gpx.fillRect( mgn+j*pixel,mgn+i*pixel,pixel,pixel );
251                                }
252                        }
253                }
254        }
255
256        /**
257         * 描画処理を行います。
258         *
259         */
260        public void saveImage() {
261                // 出力用イメージの生成
262                BufferedImage image = new BufferedImage(imageSize, imageSize, BufferedImage.TYPE_INT_BGR );
263
264                // イメージからグラフィックコンテキストを取得
265                Graphics grph = image.getGraphics();
266                grph.setColor( java.awt.Color.WHITE );
267                grph.fillRect( 0,0,imageSize, imageSize );
268                grph.setColor( java.awt.Color.BLACK );
269
270                // JEditorPane をイメージに書き込む
271                // paintComponent は proteced なので使用できない
272                paint( grph );
273
274                // 使い終わったグラフィックコンテキストを開放
275                grph.dispose();
276
277                try {
278                        // イメージの出力 Image I/O を使用
279                        ImageIO.write( image, imgType, new File( saveFile ) );
280                } catch ( IOException ex ) {
281                        String errMsg = "イメージファイルの出力に失敗しました。"
282                                        + "File=[" + saveFile + "]" ;
283                        throw new RuntimeException( errMsg,ex );
284                }
285        }
286
287        /**
288         * メイン処理です。
289         * Usage: java org.opengion.fukurou.util.QrcodeImage Encode [SaevFile]
290         *
291         * @param  args  引数文字列配列
292         */
293        public static void main( final String[] args ) {
294                if( args.length == 0 ) {
295                        LogWriter.log( "Usage: java org.opengion.fukurou.util.QrcodeImage Encode [SaevFile]" );
296                        return ;
297                }
298
299                String qrcode = args[0];
300                String file   = (args.length > 1) ? args[1] : "img.png";
301
302                QrcodeImage qrImage = new QrcodeImage();
303                qrImage.init( qrcode,file );
304                qrImage.saveImage();
305        }
306
307        /**
308         * 内部データを標準出力へ出力します。
309         *
310         */
311        public static void printQcData() {
312                char[] strJ = new char[] { 'H','M' };
313                char[] strK = new char[] { 'N','A','B' };
314
315                for( int i=0; i<QC_DATA.length; i++ ) {
316                        System.out.print( "version=[" + (i+1) + "] " );
317                        for( int j=0; j<QC_DATA[i].length; j++ ) {
318                                char errCo = strJ[j];
319                                for( int k=0; k<QC_DATA[i][j].length; k++ ) {
320                                        System.out.print( errCo + strK[k] + "=[" + QC_DATA[i][j][k] + "] " );
321                                }
322                        }
323                        System.out.println();
324                }
325        }
326
327        /**
328         * バージョン情報を取得します。
329         *
330         * @param   errCo       エラー訂正レベル ('L','M','Q','H')
331         * @param       encMd   エンコードモード ('N':数字モード 'A':英数字モード 'B':8bit byteモード)
332         * @param       len             対象範囲
333         *
334         * @return      バージョン情報
335         */
336        public static int getVersion( final ErrCrct errCo, final EncMode encMd, final int len ) {
337                int errCoInt = errCo.getNo() ;
338                int encMdInt = encMd.getNo() ;
339
340                int rtn = -1;
341                for( int i=0; i<QC_DATA.length; i++ ) {
342                        if( QC_DATA[i][errCoInt][encMdInt] >= len ) {
343                                rtn = i;
344                                break;
345                        }
346                }
347
348                if( rtn < 0 ) {
349                        String errMsg = "データ量が対象範囲を超えています。エラーレベルや、モードを調整してください。"
350                                                + "ErrCo:" + errCo + " EncMd:" + encMd + " len=[" + len + "]"
351                                                + " MaxLen=[" + QC_DATA[QC_DATA.length-1][errCoInt][encMdInt] + "]" ;
352                        throw new RuntimeException( errMsg );
353                }
354
355                return rtn + 1 ;
356        }
357
358        /**
359         * 最大サイズを取得します。
360         *
361         * @param       version バージョン情報
362         * @param   errCo       エラー訂正レベル ('L','M','Q','H')
363         * @param       encMd   エンコードモード ('N':数字モード 'A':英数字モード 'B':8bit byteモード)
364         *
365         * @return      最大サイズ
366         */
367        public static int getMaxSize( final int version, final ErrCrct errCo, final EncMode encMd ) {
368                int errCoInt = errCo.getNo() ;
369                int encMdInt = encMd.getNo() ;
370
371                return QC_DATA[version][errCoInt][encMdInt] ;
372        }
373}