357b9be38db2700776d09076a3674268965a9c4a
[debian/gnuradio] / gr-atsc / src / lib / GrAtscDeinterleaver.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2002 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include <GrAtscDeinterleaver.h>
24
25 // typedefs for fundamental i/o types
26
27 typedef atsc_mpeg_packet_rs_encoded     iType;
28 typedef atsc_mpeg_packet_rs_encoded     oType;
29
30 static const int NUMBER_OF_OUTPUTS = 1; // # of output streams (almost always one)
31
32
33 GrAtscDeinterleaver::GrAtscDeinterleaver ()
34   : VrHistoryProc<iType,oType> (NUMBER_OF_OUTPUTS)
35 {
36   // 1 + number of extra input elements at which we look.  This is
37   // used by the superclass's forecast routine to get us the correct
38   // range on our inputs.
39   // We're one-to-one input-to-output so set it to 1.
40   history = 1;  
41
42   // any other init here.
43 }
44
45 GrAtscDeinterleaver::~GrAtscDeinterleaver ()
46 {
47   // Anything that isn't automatically cleaned up...
48 }
49
50 /*
51  * This is the real work horse.  In general this interface can handle
52  * multiple streams of input and output, but we almost always
53  * use a single input and output stream.
54  */
55
56 int 
57 GrAtscDeinterleaver::work (VrSampleRange output, void *ao[],
58                            VrSampleRange inputs[], void *ai[])
59 {
60   // If we have state that persists across invocations (e.g., we have
61   // instance variables that we modify), we must use the sync method
62   // to indicate to the scheduler that our output must be computed in
63   // order.  This doesn't keep other things from being run in
64   // parallel, it just means that at any given time, there is only a
65   // single thread working this code, and that the scheduler will
66   // ensure that we are asked to produce output that is contiguous and
67   // that will be presented to us in order of increasing time.
68
69   // We have state, the current contents of the LFSR in the randomizer, hence
70   // we must use sync.
71
72   sync (output.index);
73
74   // construct some nicer i/o pointers to work with.
75
76   iType *in  = ((iType **) ai)[0];
77   oType *out = ((oType **) ao)[0];
78
79
80   // We must produce output.size units of output.
81
82   for (unsigned int i = 0; i < output.size; i++){
83     // pipeline info is handled in the primitive
84     deinterleaver.deinterleave (out[i], in[i]);
85   }
86
87   // Return the number of units we produced.
88   // Note that for all intents and purposes, it is an error to
89   // produce less than you are asked for.
90
91   return output.size;
92 }