text viewer: simplify display functions.
[kugel-rb.git] / apps / plugins / text_viewer / tv_text_processor.h
blob33e6a021f9d6b0abed96e71af1e9438d311105fc
1 /***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id$
10 * Copyright (C) 2002 Gilles Roux
11 * 2003 Garrett Derner
12 * 2010 Yoshihisa Uchida
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20 * KIND, either express or implied.
22 ****************************************************************************/
23 #ifndef PLUGIN_TEXT_VIEWER_TEXT_PROCESSOR_H
24 #define PLUGIN_TEXT_VIEWER_TEXT_PROCESSOR_H
27 * initialize the text processor module
29 * [In/Out] buf
30 * the start pointer of the buffer
32 * [In/Out] size
33 * enabled buffer size
35 * return
36 * true initialize success
37 * false initialize failure
39 bool tv_init_text_processor(unsigned char **buf, size_t *bufsize);
42 * set the processing conditions
44 * [In] blocks
45 * total block count
47 * [In] width
48 * the block width
50 void tv_set_creation_conditions(int blocks, int width);
53 * create the displayed text
55 * [In] src
56 * the start pointer of the buffer
58 * [In] bufsize
59 * buffer size
61 * [In] block
62 * the index of block to read text
64 * [In] is_multi
65 * true read 2 blocks
66 * false read 1 block
68 * [Out] dst
69 * the pointer of the pointer which store the text
71 * return
72 * the size of the text
74 int tv_create_formed_text(const unsigned char *src, ssize_t bufsize,
75 int block, bool is_multi, const unsigned char **dst);
77 #endif