scummvm/queen/talk.h

/* ScummVM - Scumm Interpreter
 * Copyright (C) 2003 The ScummVM project
 *
 * 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.
 *
 * $Header$
 *
 */

#ifndef QUEEN_TALK_H
#define QUEEN_TALK_H

#include "queen/queen.h"

namespace Queen {

class Graphics;
class Logic;
class Resource;
class Sound;
struct BobSlot;

class Talk {
  public:

	//! Public interface to run a talk from a file
	static void talk(
		const char *filename,
		int personInRoom,
		char *cutawayFilename, 
		Graphics *graphics,
		Input *input,
		Logic *logic,
		Resource *resource,
		Sound *sound);

	//! Public interface to speak a sentence
	static bool speak(
		const char *sentence, 
		Person *person, 
		const char *voiceFilePrefix,
		Graphics *graphics,
		Input *input,
		Logic *logic,
		Resource *resource,
		Sound *sound);

	//! Read a string from ptr and return new ptr
	static byte *getString(byte *ptr, char *str, int maxLength, int align = 2);

  private:
	//!  Collection of constants used by Talk
	enum {
	  MAX_STRING_LENGTH = 255,
	  MAX_STRING_SIZE = (MAX_STRING_LENGTH + 1),
	  MAX_TEXT_WIDTH = (320-18),
	  PUSHUP = 4,
	  TALK_SELECTED_COUNT = 86,
	  SENTENCE_BOB_1 = 62,
	  SENTENCE_BOB_2 = 63
	};

	//! Special commands for speech
	enum {
	  SPEAK_DEFAULT      =  0,
	  SPEAK_FACE_LEFT    = -1,
	  SPEAK_FACE_RIGHT   = -2,
	  SPEAK_FACE_FRONT   = -3,
	  SPEAK_FACE_BACK    = -4,
	  SPEAK_ORACLE       = -5,
	  SPEAK_UNKNOWN_6    = -6,
	  SPEAK_AMAL_ON      = -7,
	  SPEAK_PAUSE        = -8,
	  SPEAK_NONE         = -9
	};

	//! TODO Move this to struct.h later!
	struct TalkSelected {
	  int16 hasTalkedTo;
	  int16 values[4];
	};

	struct DialogueNode {
	  int16 head;
	  int16 dialogueNodeValue1;
	  int16 gameStateIndex;
	  int16 gameStateValue;
	};

	struct SpeechParameters {
		const char *name;								// Nstr
		signed char state,faceDirection;				// S,F
		signed char body,bf,rf,af;
		const char *animation;							// SANIMstr
		signed char ff;
	};

	Graphics  *_graphics;
	Input     *_input;
	Logic     *_logic;
	Resource  *_resource;
	Sound     *_sound;

	//! Raw .dog file data (without 20 byte header)
	byte *_fileData;

	//! Number of dialogue levels
	int16 _levelMax;

	//! Unique key for this dialogue
	int16 _uniqueKey;

	//! Used to select voice files
	int16 _talkKey;

	//! Used by findDialogueString
	int16 _pMax;

	//! String data
	byte *_person1Ptr;

	//! Data used if we have talked to the person before
	byte *_person2Ptr;

	//! Data used if we haven't talked to the person before
	byte *_joePtr;

	//! Is a talking head
	bool _talkHead;

	//! IDs for sentences
	DialogueNode _dialogueTree[18][6];

	//! TODO Move this to the Logic class later!
	TalkSelected _talkSelected[TALK_SELECTED_COUNT];

	//! Greeting from person Joe has talked to before
	char _person2String[MAX_STRING_SIZE];

	int _oldSelectedSentenceIndex;
	int _oldSelectedSentenceValue;

	char _talkString[5][MAX_STRING_SIZE];
	char _joeVoiceFilePrefix[5][MAX_STRING_SIZE];

	static const SpeechParameters _speechParameters[];

	Talk(Graphics *graphics, Input *input, Logic *logic, Resource *resource, Sound *sound);
	~Talk();

	//! Perform talk in file and return a cutaway filename
	void talk(const char *filename, int personInRoom, char *cutawayFilename);

	//! Load talk data from .dog file 
	void load(const char *filename);

	//! First things spoken
	void initialTalk();

	//! Find a string in the dialogue tree
	void findDialogueString(byte *ptr, int16 id, char *str);

	//! Get TalkSelected struct for this talk
	TalkSelected *talkSelected();

	//! The sentence will not be displayed again
	void disableSentence(int oldLevel, int selectedSentence);

	//! Select what to say
	int16 selectSentence();

	//! Speak sentence
	bool speak(const char *sentence, Person *person, const char *voiceFilePrefix);

	//! Convert command in sentence to command code
	int getSpeakCommand(const char *sentence, unsigned &index);

	//! Speak a part of a sentence
	void speakSegment(
			const char *segmentStart, 
			int length,
			Person *person, 
			int command,
			const char *voiceFilePrefix,
			int index);

	void headStringAnimation(const SpeechParameters *parameters, int bobNum, int bankNum);

	void stringAnimation(const SpeechParameters *parameters, int startFrame, int bankNum);

	void defaultAnimation(
		const char *segment, 
		bool isJoe,
		const SpeechParameters *parameters, 
		int startFrame, 
		int bankNum);

	int countSpaces(const char *segment);

	//! Get special parameters for speech
	const SpeechParameters *findSpeechParameters(
			const char *name, 
			int state, 
			int faceDirection); // FIND_SACTION

	static int splitOption(const char *str, char optionText[5][MAX_STRING_SIZE]);


};

} // End of namespace Queen

#endif