audio_input_ipc.h revision c2e0dbddbe15c98d52c4786dac06cb8952a8ae6d
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef MEDIA_AUDIO_AUDIO_INPUT_IPC_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define MEDIA_AUDIO_AUDIO_INPUT_IPC_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/shared_memory.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/sync_socket.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "media/audio/audio_parameters.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "media/base/media_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace media { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Contains IPC notifications for the state of the server side 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (AudioInputController) audio state changes and when an AudioInputController 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// has been created. Implemented by AudioInputDevice. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MEDIA_EXPORT AudioInputIPCDelegate { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Valid states for the input stream. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum State { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kRecording, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kStopped, 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kError 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when an AudioInputController has been created. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The shared memory |handle| points to a memory section that's used to 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // transfer data between the AudioInputDevice and AudioInputController 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // objects. The implementation of OnStreamCreated takes ownership. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The |socket_handle| is used by the AudioInputController to signal 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // notifications that more data is available and can optionally provide 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parameter changes back. The AudioInputDevice must read from this socket 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and process the shared memory whenever data is read from the socket. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnStreamCreated(base::SharedMemoryHandle handle, 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::SyncSocket::Handle socket_handle, 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int length, 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int total_segments) = 0; 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when state of an audio stream has changed. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnStateChanged(State state) = 0; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the input stream volume has changed. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnVolume(double volume) = 0; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the AudioInputIPC object is going away and/or when the 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IPC channel has been closed and no more IPC requests can be made. 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Implementations should delete their owned AudioInputIPC instance 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // immediately. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnIPCClosed() = 0; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~AudioInputIPCDelegate(); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// Provides IPC functionality for an AudioInputIPCDelegate (e.g., an 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// AudioInputDevice). The implementation should asynchronously deliver the 58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// messages to an AudioInputController object (or create one in the case of 59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// CreateStream()), that may live in a separate process. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MEDIA_EXPORT AudioInputIPC { 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual ~AudioInputIPC(); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends a request to create an AudioInputController object in the peer 65c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // process, and configures it to use the specified audio |params|. The 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // |total_segments| indidates number of equal-lengthed segments in the shared 67c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // memory buffer. Once the stream has been created, the implementation will 68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // notify |delegate| by calling OnStreamCreated(). 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void CreateStream(AudioInputIPCDelegate* delegate, 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int session_id, 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const AudioParameters& params, 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool automatic_gain_control, 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) uint32 total_segments) = 0; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Corresponds to a call to AudioInputController::Record() on the server side. 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void RecordStream() = 0; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the volume of the audio stream. 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void SetVolume(double volume) = 0; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 81c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Closes the audio stream, which should shut down the corresponding 82c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // AudioInputController in the peer process. 83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void CloseStream() = 0; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace media 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // MEDIA_AUDIO_AUDIO_INPUT_IPC_H_ 89