contentLister/src/click.c File Reference

content lister - eReader key/pen click handling More...

#include <config.h>
#include <sys/stat.h>
#include <errno.h>
#include <fcntl.h>
#include <pthread.h>
#include <stdio.h>
#include <unistd.h>
#include <sys/ioctl.h>
#include <sys/soundcard.h>
#include <glib.h>
#include <liberregxml/erregapi.h>
#include "contentListerLog.h"
#include "click.h"

Go to the source code of this file.

Defines
#define	SNDCTL_POWER_OFF   _SIO('P', 99)
#define	SNDCTL_POWER_ON   _SIO('P', 100)
#define	MIXER   "/dev/mixer"
Functions
static void *	click_thread (void *arg)
static void	destroy_waveforms ()
static gboolean	read_waveforms ()
static void	enable_audio_device (gboolean bEnable)
static void	set_volume (int volume)
gboolean	click_init ()
void	handle_sound_settings_changed (int volume)
static void	play_sound (playSoundType_e sound)
void	click_key ()
void	click_key_discard ()
void	click_pen ()
Variables
static int	g_volume_settings = 0
static wavFile_t	g_wav_files [playUndefined]
static pthread_mutex_t	g_click_mutex
static playSoundType_e	g_play_sound

---

Detailed Description

content lister - eReader key/pen click handling

Generate key/pen clicks on request

Definition in file click.c.

---

Define Documentation

#define MIXER   "/dev/mixer"

Definition at line 53 of file click.c.

#define SNDCTL_POWER_OFF   _SIO('P', 99)

Definition at line 42 of file click.c.

#define SNDCTL_POWER_ON   _SIO('P', 100)

Definition at line 43 of file click.c.

---

Function Documentation

gboolean click_init

(

)

Definition at line 150 of file click.c.

{
    int err;
    pthread_t click_tid;
    regUserSetting_t *theUserSetting = NULL;
    
    // Retrieve user setting from registry
    // Setup the mixer volumes according to the users wishes
    theUserSetting = erRegGetUserSetting();
    if (theUserSetting)
    {
        g_volume_settings = theUserSetting->volume;
        erRegFreeUserSetting (theUserSetting);
    }
    else
    {
        // default is on
        g_volume_settings = 75;
    }

    // Turn on/off the audio device according to the settings
    enable_audio_device(g_volume_settings>0 ? TRUE : FALSE);

    if (g_volume_settings > 0)
    {
        // The sound is on, set the volume
        set_volume(g_volume_settings);
    }

    // Second, read the waveforms
    if (!read_waveforms())
    {
        CL_ERRORPRINTF("Error reading waveforms.");
        return FALSE;
    }

    // Initialize mutex
    err = pthread_mutex_init (&g_click_mutex, NULL);
    if (err != 0)
    {
        CL_ERRORPRINTF ("Mutex init error [%d]", err);
        destroy_waveforms();
        return FALSE;
    }

    // start click-thread
    err = pthread_create (&click_tid, NULL, click_thread, NULL);
    if (err != 0)
    {
        CL_ERRORPRINTF ("start click-thread error [%d]", err);
        destroy_waveforms();
        return FALSE;
    }

    // get here, success
    return TRUE;
}

Here is the call graph for this function:

void click_key

(

)

play click key sound

Definition at line 245 of file click.c.

{
    play_sound(playClickedKey);
}

Here is the call graph for this function:

void click_key_discard

(

)

play click key discarded sound

Definition at line 250 of file click.c.

{
    play_sound(playClickedKeyDiscarded);
}

Here is the call graph for this function:

void click_pen

(

)

play click pen sound

Definition at line 255 of file click.c.

{
    play_sound(playClickedPen);
}

Here is the call graph for this function:

static void * click_thread

(

void *

arg

)

[static]

Definition at line 260 of file click.c.

{
    int fd;   
 
    pthread_mutex_lock (&g_click_mutex);
    while (1)
    {
        char* waveform = NULL;
        int size=0;
       
        // wait for mutex
        pthread_mutex_lock (&g_click_mutex);

        // click once
        waveform = g_wav_files[g_play_sound].waveform;
        size     = g_wav_files[g_play_sound].wav_file_size;

        if (waveform != NULL && size != 0)
        {
            fd = open (AUDIO_DEVICE, O_WRONLY);
            if (fd <= 0)
            {
                CL_ERRORPRINTF("Open error [%d] device [%s]", errno, AUDIO_DEVICE);
            }
            else
            {
                write (fd, waveform, size);
                close (fd);
            }
        }    
    }
}

static void destroy_waveforms

(

)

[static]

Definition at line 73 of file click.c.

{
    int i;
    for (i=0; i<playUndefined; i++)
    {
        if (g_wav_files[i].wav_file_size)
        {
            g_free(g_wav_files[i].waveform);
            g_wav_files[i].waveform = NULL;
            g_wav_files[i].wav_file_size = 0;
        }
    }
}

static void enable_audio_device

(

gboolean

bEnable

)

[static]

Definition at line 129 of file click.c.

{
    int audio_fd = open(AUDIO_DEVICE, O_RDWR);
    g_assert(audio_fd >= 0);
    int result = ioctl(audio_fd, bEnable ? SNDCTL_POWER_ON : SNDCTL_POWER_OFF, 0);
    g_assert (result != -1);
    close(audio_fd);
}

void handle_sound_settings_changed

(

int

volume

)

Definition at line 208 of file click.c.

{
    g_volume_settings = volume;
    
    // Turn on/off the audio device according to the settings
    enable_audio_device(g_volume_settings>0 ? TRUE : FALSE);

    if (g_volume_settings > 0)
    {
        // The sound is on, set the volume
        set_volume(g_volume_settings);
    }
}

Here is the call graph for this function:

static void play_sound

(

playSoundType_e

sound

)

[static]

Definition at line 223 of file click.c.

{
    CL_LOGPRINTF("click: play %d sound",  g_play_sound);

    if (0 == g_volume_settings)
    {
        // The sound is disabled, do nothing
        return;
    }

    if ( (sound >= playClickedKey) && (sound < playUndefined) )
    {
        g_play_sound = sound;
    }
    else
    {
        g_play_sound = playClickedKey;
    }
   
    pthread_mutex_unlock (&g_click_mutex); 
}

static gboolean read_waveforms

(

)

[static]

Definition at line 88 of file click.c.

{
    int i, n, fd;
    for (i=0; i<playUndefined; i++)
    {
        fd = open(g_wav_files[i].wav_file_path, O_RDONLY);
        if (fd <= 0)
        {
            CL_ERRORPRINTF ("Open error [%d] file [%s]", errno, g_wav_files[i].wav_file_path);
            goto Error;
        }

        g_wav_files[i].wav_file_size = lseek(fd, 0, SEEK_END);
        g_wav_files[i].waveform = g_new(char, g_wav_files[i].wav_file_size);
        if (NULL == g_wav_files[i].waveform)
        {
            CL_ERRORPRINTF("Error allocating memory for waveforms.");
            close(fd);
            goto Error;
        }

        lseek (fd, 0, SEEK_SET);
        n = read (fd, g_wav_files[i].waveform, g_wav_files[i].wav_file_size);
        if (n != g_wav_files[i].wav_file_size)
        {
            CL_ERRORPRINTF("Read error [%d] file [%s]", errno, g_wav_files[i].wav_file_path);
            close(fd);
            goto Error;
        }

        // Successfully read g_wav_files[i]
        close(fd);
    }

    return TRUE;

Error:
    destroy_waveforms();
    return FALSE;
}

Here is the call graph for this function:

static void set_volume

(

int

volume

)

[static]

Definition at line 138 of file click.c.

{
    int mixer_fd = open (MIXER, O_RDWR);
    g_assert (mixer_fd >= 0);
    volume = (volume << 8) | volume;   // both channels equally loud
    int result = ioctl (mixer_fd, SOUND_MIXER_WRITE_VOLUME, &volume);
    g_assert (result != -1);
    close (mixer_fd);
}

---

Variable Documentation

pthread_mutex_t g_click_mutex [static]

Definition at line 65 of file click.c.

playSoundType_e g_play_sound [static]

Definition at line 67 of file click.c.

int g_volume_settings = 0 [static]

Definition at line 56 of file click.c.

wavFile_t g_wav_files[playUndefined] [static]

Initial value:

 
{
    {FILENAME_KEY_CLICK, 0, NULL},
    {FILENAME_KEY_CLICK_DISCARDED, 0, NULL},
    {FILENAME_PEN_CLICK, 0, NULL}
}

Definition at line 58 of file click.c.