/*
 *  Copyright (C) 2008 Savoir-Faire Linux inc.
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.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 3 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _AUDIO_STREAM_H
#define _AUDIO_STREAM_H

#include <pulse/pulseaudio.h>
#include <string>

#include "../global.h"
#include "ringbuffer.h"
#include "audioloop.h"

#include <cc++/thread.h>

/**
 * This data structure contains the different king of audio streams available
 */
enum STREAM_TYPE {
  PLAYBACK_STREAM,
  CAPTURE_STREAM,
  UPLOAD_STREAM
};


class AudioStream {
  public:
    /**
     * Constructor
     * @param context The pulseaudio context
     * @param type    The type of audio stream
     * @param desc    The stream name
     */ 
    AudioStream(pa_context* context , int type, std::string desc, double vol);
    
    /**
     * Destructor
     */   
    ~AudioStream();

    /**
     * Write data to the main abstraction ring buffer. 
     * @param buffer The buffer containing the data to be played
     * @param toCopy The number of samples, in bytes
     * @return int The number of bytes played
     */
    int putMain( void* buffer , int toCopy );

    /**
     * Write data to the urgent abstraction ring buffer. ( dtmf , double calls )
     * @param buffer The buffer containing the data to be played
     * @param toCopy The number of samples, in bytes
     * @return int The number of bytes played
     */
    int putUrgent( void* buffer , int toCopy );

    /**
     * Connect the pulse audio stream
     */
    bool connectStream();

    /**
     * Disconnect the pulseaudio stream
     */
    bool disconnectStream();
    
    /**
     * Accessor: Get the pulseaudio stream object
     * @return pa_stream* The stream
     */
    pa_stream* pulseStream(){ return _audiostream; }

    /**
     * Accessor
     * @return std::string  The stream name
     */
    std::string getStreamName( void ) { return _streamDescription; }

    /**
     * Accessor
     * @param name  The stream name
     */
    void setStreamName( std::string name ) {  _streamDescription = name; }

    void setVolume( double pc ) { _volume.values[0] *= pc/100; }
    pa_cvolume getVolume( void ) { return _volume; }

    /**
     * Accessor
     * @return stream state
     */
    pa_stream_state_t getStreamState(void);

    

  private:
  
    // Copy Constructor
    AudioStream(const AudioStream& rh);

    // Assignment Operator
    AudioStream& operator=( const AudioStream& rh);

    /**
     * Create the audio stream into the given context
     * @param c	The pulseaudio context
     * @return pa_stream* The newly created audio stream
     */
    pa_stream* createStream( pa_context* c ); 

    /**
     * Mandatory asynchronous callback on the audio stream state
     */
    static void stream_state_callback( pa_stream* s, void* user_data );	
    
    /**
     * Asynchronous callback on data processing ( write and read )
     */
    static void audioCallback ( pa_stream* s, size_t bytes, void* userdata );
    
    /**
     * Write data to the sound device
     */
    void write( void );

    /**
     * The pulse audio context
     */
    pa_context* _context;

    /**
     * The pulse audio object
     */
    pa_stream* _audiostream;
    
    /**
     * The type of the stream
     */
    int _streamType;
    
    /**
     * The name of the stream
     */
    std::string _streamDescription;
    
    /**
     * Streams parameters
     */
    pa_stream_flags_t flag;
    pa_sample_spec sample_spec ;
    pa_cvolume _volume;

    ost::Mutex _mutex;

};

#endif // _AUDIO_STREAM_H