Support planar sample formats in audio mixdown
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGWriter.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/ffmpeg/AUD_FFMPEGWriter.h
26  *  \ingroup audffmpeg
27  */
28
29
30 #ifndef __AUD_FFMPEGWRITER_H__
31 #define __AUD_FFMPEGWRITER_H__
32
33 #include "AUD_ConverterFunctions.h"
34 #include "AUD_Buffer.h"
35 #include "AUD_IWriter.h"
36
37 #include <string>
38
39 struct AVCodecContext;
40 extern "C" {
41 #include <libavformat/avformat.h>
42 }
43
44 /**
45  * This class writes a sound file via ffmpeg.
46  */
47 class AUD_FFMPEGWriter : public AUD_IWriter
48 {
49 private:
50         /**
51          * The current position in samples.
52          */
53         int m_position;
54
55         /**
56          * The specification of the audio data.
57          */
58         AUD_DeviceSpecs m_specs;
59
60         /**
61          * The AVFormatContext structure for using ffmpeg.
62          */
63         AVFormatContext* m_formatCtx;
64
65         /**
66          * The AVCodecContext structure for using ffmpeg.
67          */
68         AVCodecContext* m_codecCtx;
69
70         /**
71          * The AVOutputFormat structure for using ffmpeg.
72          */
73         AVOutputFormat* m_outputFmt;
74
75         /**
76          * The AVStream structure for using ffmpeg.
77          */
78         AVStream* m_stream;
79
80         /**
81          * Frame sent to the encoder.
82          */
83         AVFrame *m_frame;
84
85         /**
86          * PTS of next frame to write.
87          */
88         int m_frame_pts;
89
90         /**
91          * Number of bytes per sample.
92          */
93         int m_sample_size;
94
95         /**
96          * Need to de-interleave audio for planar sample formats.
97          */
98         bool m_deinterleave;
99
100         AUD_Buffer m_deinterleave_buffer;
101
102         /**
103          * The input buffer for the format converted data before encoding.
104          */
105         AUD_Buffer m_input_buffer;
106
107         /**
108          * The output buffer for the encoded audio data.
109          */
110         AUD_Buffer m_output_buffer;
111
112         /**
113          * The count of input samples we have so far.
114          */
115         unsigned int m_input_samples;
116
117         /**
118          * The count of input samples necessary to encode a packet.
119          */
120         unsigned int m_input_size;
121
122         /**
123          * Converter function.
124          */
125         AUD_convert_f m_convert;
126
127         // hide copy constructor and operator=
128         AUD_FFMPEGWriter(const AUD_FFMPEGWriter&);
129         AUD_FFMPEGWriter& operator=(const AUD_FFMPEGWriter&);
130
131         /**
132          * Encodes to the output buffer.
133          * \param data Pointer to the data to encode.
134          */
135         void encode(sample_t* data);
136
137 public:
138         /**
139          * Creates a new writer.
140          * \param filename The path to the file to be read.
141          * \param specs The file's audio specification.
142          * \param format The file's container format.
143          * \param codec The codec used for encoding the audio data.
144          * \param bitrate The bitrate for encoding.
145          * \exception AUD_Exception Thrown if the file specified does not exist or
146          *            cannot be read with ffmpeg.
147          */
148         AUD_FFMPEGWriter(std::string filename, AUD_DeviceSpecs specs, AUD_Container format, AUD_Codec codec, unsigned int bitrate);
149
150         /**
151          * Destroys the writer and closes the file.
152          */
153         virtual ~AUD_FFMPEGWriter();
154
155         virtual int getPosition() const;
156         virtual AUD_DeviceSpecs getSpecs() const;
157         virtual void write(unsigned int length, sample_t* buffer);
158 };
159
160 #endif //__AUD_FFMPEGWRITER_H__