Documentation of the MLV-2.0.2 library

/*
 *   This file is part of the MLV Library.
 *
 *   Copyright (C) 2010,2011,2012 Adrien Boussicault, Marc Zipstein
 *
 *
 *    This Library 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 3 of the License, or
 *    (at your option) 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 General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this Library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __MLV__MLV_ANIMATION_H__
#define __MLV__MLV_ANIMATION_H__

#include "MLV_image.h"
#include "MLV_audio.h"

#ifdef __cplusplus
extern "C" {
#endif

//    Animation data

typedef struct _MLV_Animation MLV_Animation;

MLV_Animation* MLV_create_animation(
        unsigned int nb_frames, unsigned int nb_layers, unsigned int nb_channels
);

void MLV_free_animation( MLV_Animation* animation );

void MLV_change_frame_in_animation(
        MLV_Image** array_of_images, MLV_Sound** array_of_sounds, unsigned int delay,
        MLV_Animation* animation, unsigned int position
);

void MLV_change_frame_image_in_animation(
        MLV_Image* image, MLV_Animation* animation, unsigned int position,
        unsigned int layer
);

void MLV_change_frame_sound_in_animation(
        MLV_Sound* sound, MLV_Animation* animation, unsigned int position,
        unsigned int channel
);

void MLV_change_frame_delay_in_animation(
        unsigned int delay, MLV_Animation* animation, unsigned int position
);

void MLV_get_frame_from_animation(
        MLV_Animation* animation, unsigned int position,
        unsigned int layer,
        MLV_Image** image, unsigned int* delay
);



int MLV_get_frame_delay_from_animation(
        MLV_Animation* animation, unsigned int position
);

MLV_Image* MLV_get_frame_image_from_animation(
        MLV_Animation* animation, unsigned int position,
        unsigned int layer
);




//    Animation engine

typedef struct _MLV_Animation_player MLV_Animation_player;


MLV_Animation_player* MLV_create_animation_player( MLV_Animation* animation );

void MLV_free_animation_player( MLV_Animation_player* animation_player );

void MLV_play_animation_player( MLV_Animation_player* animation_player );

void MLV_play_revert_animation_player( MLV_Animation_player* animation_player );

void MLV_stop_animation_player( MLV_Animation_player* animation_player );

void MLV_rewind_animation_player( MLV_Animation_player* animation_player );

void MLV_next_frame( MLV_Animation_player* animation_player );

void MLV_previous_frame( MLV_Animation_player* animation_player );

void MLV_update_animation_player( MLV_Animation_player* animation_player );

void MLV_change_sound_volume_of_animation_player(
        MLV_Animation_player* animation_player, unsigned int channel, float volume
);

void MLV_turn_on_sound_of_animation_player(
        MLV_Animation_player* animation_player, unsigned int channel
);

void MLV_turn_off_sound_of_animation_player(
        MLV_Animation_player* animation_player, unsigned int channel
);


//    Drawing animation

void MLV_draw_image_from_animation_player(
        MLV_Animation_player* animation_player, unsigned int layer,
        int x, int y
);

void MLV_play_sound_from_animation_player(
        MLV_Animation_player* animation_player, unsigned int layer
);

void MLV_play_sounds_from_animation_player(
        MLV_Animation_player* animation_player,
        ...
);

void MLV_play_list_of_sounds_from_animation_player(
        MLV_Animation_player* animation_player, unsigned int* layers,
        unsigned int nb_layers
);


void MLV_draw_partial_image_from_animation_player(
        MLV_Animation_player* animation_player, unsigned int layer,
        int source_x, int source_y, int source_width, int source_height,
        MLV_Image* image,
        int x, int y
);

void MLV_draw_image_from_animation_player_on_image(
        MLV_Animation_player* animation_player, unsigned int layer,
        MLV_Image* image,
        int x, int y
);

void MLV_draw_partial_image_from_animation_player_on_image(
        MLV_Animation_player* animation_player, unsigned int layer,
        int source_x, int source_y, int source_width, int source_height,
        MLV_Image* image,
        int x, int y
);




//    Loading animations from files

typedef struct _MLV_Animation_book MLV_Animation_book;


MLV_Animation_book* MLV_load_animation_book(
        const char* xml_file,
        const char* image_directory,
        const char* sound_directory
);

void MLV_free_animation_book(
        MLV_Animation_book* animation_book
);

int MLV_get_number_of_animations(
        MLV_Animation_book* animation_book
);

MLV_Animation* MLV_get_animation_from_id(
        MLV_Animation_book* animation_book,
        int id
);

MLV_Animation* MLV_get_animation_from_name(
        MLV_Animation_book* animation_book,
        const char* name
);

const char* MLV_get_name_from_id_animation(
        MLV_Animation_book* animation_book, int id_animation
);

void MLV_add_frame_in_animation(
        MLV_Image** array_of_images, MLV_Sound** array_of_sounds,  unsigned int delay,
        MLV_Animation* animation
);

#ifdef __cplusplus
}
#endif

#endif