---

control.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006 by André Lindhjem <belgarat@sdf.lonestar.org>,     *
 *                         Kjetil Holien <kjetil.holien@gmail.com>,        *
 *                         Terje Risa <terje.risa@gmail.com> &             *
 *                         Øyvind Nerbråten <oyvind@nerbraten.com>         *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************
 *
 * \file control.h
 * \author André Lindhjem, Kjetil Holien, Terje Risa & Øyvind Nerbråten
 * \date 23.02.2006
 * 
 * Datastructure and methods for controlling it.
 */

 
#ifndef CONTROL_H_
#define CONTROL_H_

#include <pthread.h>
#include "libdaisy.h"
#include "audio.h"



/* ************************************************** *
 *              Global data structures                *
 * ************************************************** */

struct DaisyData
{
    /* Pointers to head, tail and current position in the linked list containing all the smilfiles
     * representing the spine of the loaded daisy DTB (this normally represents all chapters).
     */
    struct SmilNode *smilHead, *smilTail, *smilPos;
        
    /* Pointers to head, tail and current position in the linked list containing all passage
     * nodes of a parsed smilfile.
     */
    struct Node *nodeHead, *nodeTail, *nodePos;
    
    /* Pointer to a struct containing the metadata of the loaded daisy DTB. */
    struct BookInfo *bookInfo;
    
    /* Pointer to head and tail of a linked list containing information off all authors
     * of the loaded daisy DTB.
     */
    struct AuthorNode *authorHead, *authorTail;
    
    /* Representing the book version format (e.g. 2.02) */
    int format;
    
    /* Used by the smilparsers to define if a smil file is already present */
    int smilAlreadyfound;
    
    /* The path to the directory where the daisy DTB is loaded. */
    char *path;
    
    /* Audio engine thread for the loaded daisy DTB. */
    pthread_t thread_audio;
};

struct BookInfo
{
    char *titleText; /* the title of the book */
    char *titleAudiofilename; /* the source to the audiofile containing the title */
    char *titleAudioStartPos; /* the time offset for where to start playback in the audio file */
    char *titleAudioStopPos; /* the time offset for where to stop playback in the audio file */
    char *titleImage; /* the source to the book image */
    char *totalTime; /* the total time of the book */
    struct AuthorNode *author; /* a linked list containing the authors with their respective text,audiofilename, audiostart/stopos and image */
};

struct AuthorNode
{
    char *name; /* the title of the book */
    char *audiofilename; /* the source to the audiofile containing the title */
    char *audioStartPos; /* the time offset for where to start playback in the audio file */
    char *audioStopPos; /* the time offset for where to stop playback in the audio file */
    char *image; /* the source to the book image */
    struct AuthorNode *next; /* a pointer to the next authornode in the linked list */
    struct AuthorNode *prev; /* a pointer to the previous authornode in the linked list */
};

struct SmilNode
{
    int optional; /* marks optional passages */
    char *id; /* id for the SMIL file */ 
    char *anchor; /* the name of the SMIL file */
    char *header; /* the header of the contens of the smilfile */
    char *fragmentIdentifier; /* identifies a <par> or <text> element in the SMIL file */
    char *textpassage; /* a text corresponding to the smilNode */
    char *audiofilename; /* the filname of the corresponding audio file */
    char *audioStartPos; /* the time offset for where to start playback in the audio file */
    char *audioStopPos; /* the time offset for where to stop playback in the audio file */
    char *image; /* the source to the corresponding image */
    struct SmilNode *next; /* a pointer to the next smilnode in the linked list */
    struct SmilNode *prev;  /* a pointer to the previous smilnode in the linked list */
};

struct Node
{ 
    /*int skippable;  true if the node is auto skippable (normally false) */
    char *audiofilename; /* the filname of the corresponding audio file */
    char *audioStartPos; /* the time offset for where to start playback in the audio file */
    char *audioStopPos; /* the time offset for where to stop playback in the audio file */
    char *textfilename; /* the file_name of the corresponding text file */
    char *fragmentIdentifier; /* identificator for the corresponding passage in the text file */
    char *textPassage; /* the corresponding text passage */
    char *image; /* the source to the corresponding image */
    struct Node *next; /* a pointer to the next node in the lined list */
    struct Node *prev; /* a pointer to the previous node int the linked list */
};



/* ************************************************** *
 *          Global function declarations              *
 * ************************************************** */

struct DaisyData *parseInit (void);

void parseTerminate (struct DaisyData *daisydata);

char* removewhitespaces(char* string);

char* tolowercase(const char* string);

char* getTime(char* time);

void addNewAuthor (struct DaisyData *daisydata);

struct SmilNode* addNewSmilNode (struct DaisyData *daisydata);

struct Node* addNewNode (struct DaisyData *daisydata);

int parse (struct DaisyData *daisydata, char* filename);

int seek (struct DaisyData *daisydata, int type);

int getSmilPos (struct DaisyData *daisydata);

int getNodePos (struct DaisyData *daisydata);

int gotoSmilPosition (struct DaisyData *daisydata, int newSmilPos);

int gotoNodePosition (struct DaisyData *daisydata, int newNodePos);


#endif /*CONTROL_H_*/

---